apidoc/api_data.js

   1 define({ "api": [
   2   {
   3     "type": "post",
   4     "url": "/api/cm/hopper/timezone",
   5     "title": "Gets a single TZ data",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/cm/hopper/timezone -d '{\"timezone\": [1]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "getTimezone",
  14     "version": "0.0.0",
  15     "filename": "server/api/cmHopper/index.js",
  16     "group": "/var/opt/motion2/server/api/cmHopper/index.js",
  17     "groupTitle": "/var/opt/motion2/server/api/cmHopper/index.js"
  18   },
  19   {
  20     "type": "delete",
  21     "url": "/api/square/projects/{id}/users",
  22     "title": "Removes user permissions from a Project",
  23     "examples": [
  24       {
  25         "title": "Example usage:",
  26         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
  27         "type": "json"
  28       }
  29     ],
  30     "version": "0.0.0",
  31     "filename": "server/api/squareProject/index.js",
  32     "group": "/var/opt/motion2/server/api/squareProject/index.js",
  33     "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
  34     "name": "DeleteApiSquareProjectsIdUsers"
  35   },
  36   {
  37     "type": "get",
  38     "url": "/api/square/projects/{id}/users",
  39     "title": "Gets users permissions from Project",
  40     "examples": [
  41       {
  42         "title": "Example usage:",
  43         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
  44         "type": "json"
  45       }
  46     ],
  47     "version": "0.0.0",
  48     "filename": "server/api/squareProject/index.js",
  49     "group": "/var/opt/motion2/server/api/squareProject/index.js",
  50     "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
  51     "name": "GetApiSquareProjectsIdUsers"
  52   },
  53   {
  54     "type": "post",
  55     "url": "/api/square/projects/{id}/users",
  56     "title": "Adds user permissions to a Project",
  57     "examples": [
  58       {
  59         "title": "Example usage:",
  60         "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",
  61         "type": "json"
  62       }
  63     ],
  64     "version": "0.0.0",
  65     "filename": "server/api/squareProject/index.js",
  66     "group": "/var/opt/motion2/server/api/squareProject/index.js",
  67     "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
  68     "name": "PostApiSquareProjectsIdUsers"
  69   },
  70   {
  71     "type": "delete",
  72     "url": "/api/actions/{id}",
  73     "title": "Deletes a Action",
  74     "examples": [
  75       {
  76         "title": "Example usage:",
  77         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  78         "type": "json"
  79       }
  80     ],
  81     "name": "DeleteActions",
  82     "group": "Actions",
  83     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  84     "version": "0.0.0",
  85     "filename": "server/api/action/index.js",
  86     "groupTitle": "Actions"
  87   },
  88   {
  89     "type": "put",
  90     "url": "/api/actions/{id}",
  91     "title": "Update an existing Action",
  92     "examples": [
  93       {
  94         "title": "Example usage:",
  95         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  96         "type": "json"
  97       }
  98     ],
  99     "name": "updateActions",
 100     "group": "Actions",
 101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 102     "version": "0.0.0",
 103     "filename": "server/api/action/index.js",
 104     "groupTitle": "Actions"
 105   },
 106   {
 107     "type": "post",
 108     "url": "/api/analytics/custom_reports",
 109     "title": "Creates a new Analytic Custom Report",
 110     "examples": [
 111       {
 112         "title": "Example usage:",
 113         "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",
 114         "type": "json"
 115       }
 116     ],
 117     "name": "CreateAnalytic_Custom_Reports",
 118     "group": "Analytic_Custom_Reports",
 119     "parameter": {
 120       "fields": {
 121         "Body": [
 122           {
 123             "group": "Body",
 124             "type": "String",
 125             "optional": false,
 126             "field": "name",
 127             "description": ""
 128           },
 129           {
 130             "group": "Body",
 131             "type": "String",
 132             "optional": true,
 133             "field": "description",
 134             "description": ""
 135           },
 136           {
 137             "group": "Body",
 138             "type": "String",
 139             "optional": true,
 140             "field": "parent",
 141             "description": ""
 142           },
 143           {
 144             "group": "Body",
 145             "type": "String",
 146             "optional": true,
 147             "field": "table",
 148             "description": ""
 149           },
 150           {
 151             "group": "Body",
 152             "type": "Text",
 153             "optional": true,
 154             "field": "conditions",
 155             "description": ""
 156           },
 157           {
 158             "group": "Body",
 159             "type": "Text",
 160             "optional": true,
 161             "field": "joins",
 162             "description": ""
 163           }
 164         ]
 165       }
 166     },
 167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 168     "version": "0.0.0",
 169     "filename": "server/api/analyticCustomReport/index.js",
 170     "groupTitle": "Analytic_Custom_Reports"
 171   },
 172   {
 173     "type": "delete",
 174     "url": "/api/analytics/custom_reports/{id}",
 175     "title": "Deletes a Analytic Custom Report",
 176     "examples": [
 177       {
 178         "title": "Example usage:",
 179         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 180         "type": "json"
 181       }
 182     ],
 183     "name": "DeleteAnalytic_Custom_Reports",
 184     "group": "Analytic_Custom_Reports",
 185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 186     "version": "0.0.0",
 187     "filename": "server/api/analyticCustomReport/index.js",
 188     "groupTitle": "Analytic_Custom_Reports"
 189   },
 190   {
 191     "type": "get",
 192     "url": "/api/analytics/custom_reports",
 193     "title": "Gets a list of Analytic Custom Reports",
 194     "examples": [
 195       {
 196         "title": "Example usage:",
 197         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 198         "type": "json"
 199       }
 200     ],
 201     "name": "GetAnalytic_Custom_Reports",
 202     "group": "Analytic_Custom_Reports",
 203     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 204     "version": "0.0.0",
 205     "filename": "server/api/analyticCustomReport/index.js",
 206     "groupTitle": "Analytic_Custom_Reports"
 207   },
 208   {
 209     "type": "get",
 210     "url": "/api/analytics/custom_reports/{id}",
 211     "title": "Gets a single Analytic Custom Report",
 212     "examples": [
 213       {
 214         "title": "Example usage:",
 215         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 216         "type": "json"
 217       }
 218     ],
 219     "name": "ShowAnalytic_Custom_Reports",
 220     "group": "Analytic_Custom_Reports",
 221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 222     "version": "0.0.0",
 223     "filename": "server/api/analyticCustomReport/index.js",
 224     "groupTitle": "Analytic_Custom_Reports"
 225   },
 226   {
 227     "type": "get",
 228     "url": "/api/analytics/custom_reports/{id}/preview",
 229     "title": "Report Preview",
 230     "examples": [
 231       {
 232         "title": "Example usage:",
 233         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 234         "type": "json"
 235       }
 236     ],
 237     "name": "preview",
 238     "group": "Analytic_Custom_Reports",
 239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 240     "version": "0.0.0",
 241     "filename": "server/api/analyticCustomReport/index.js",
 242     "groupTitle": "Analytic_Custom_Reports"
 243   },
 244   {
 245     "type": "get",
 246     "url": "/api/analytics/custom_reports/{id}/query",
 247     "title": "Report Query SQL",
 248     "examples": [
 249       {
 250         "title": "Example usage:",
 251         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 252         "type": "json"
 253       }
 254     ],
 255     "name": "query",
 256     "group": "Analytic_Custom_Reports",
 257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 258     "version": "0.0.0",
 259     "filename": "server/api/analyticCustomReport/index.js",
 260     "groupTitle": "Analytic_Custom_Reports"
 261   },
 262   {
 263     "type": "get",
 264     "url": "/api/analytics/custom_reports/{id}/run",
 265     "title": "Report Run",
 266     "examples": [
 267       {
 268         "title": "Example usage:",
 269         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 270         "type": "json"
 271       }
 272     ],
 273     "name": "run",
 274     "group": "Analytic_Custom_Reports",
 275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 276     "version": "0.0.0",
 277     "filename": "server/api/analyticCustomReport/index.js",
 278     "groupTitle": "Analytic_Custom_Reports"
 279   },
 280   {
 281     "type": "put",
 282     "url": "/api/analytics/custom_reports/{id}",
 283     "title": "Update an existing Analytic Custom Report",
 284     "examples": [
 285       {
 286         "title": "Example usage:",
 287         "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",
 288         "type": "json"
 289       }
 290     ],
 291     "name": "updateAnalytic_Custom_Reports",
 292     "group": "Analytic_Custom_Reports",
 293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 294     "version": "0.0.0",
 295     "filename": "server/api/analyticCustomReport/index.js",
 296     "groupTitle": "Analytic_Custom_Reports"
 297   },
 298   {
 299     "type": "post",
 300     "url": "/api/analytics/default_reports",
 301     "title": "Creates a new Analytic Default Report",
 302     "examples": [
 303       {
 304         "title": "Example usage:",
 305         "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",
 306         "type": "json"
 307       }
 308     ],
 309     "name": "CreateAnalytic_Default_Reports",
 310     "group": "Analytic_Default_Reports",
 311     "parameter": {
 312       "fields": {
 313         "Body": [
 314           {
 315             "group": "Body",
 316             "type": "String",
 317             "optional": false,
 318             "field": "name",
 319             "description": ""
 320           },
 321           {
 322             "group": "Body",
 323             "type": "String",
 324             "optional": true,
 325             "field": "description",
 326             "description": ""
 327           },
 328           {
 329             "group": "Body",
 330             "type": "String",
 331             "optional": true,
 332             "field": "parent",
 333             "description": ""
 334           },
 335           {
 336             "group": "Body",
 337             "type": "String",
 338             "optional": true,
 339             "field": "table",
 340             "description": ""
 341           },
 342           {
 343             "group": "Body",
 344             "type": "Text",
 345             "optional": true,
 346             "field": "conditions",
 347             "description": ""
 348           },
 349           {
 350             "group": "Body",
 351             "type": "Text",
 352             "optional": true,
 353             "field": "joins",
 354             "description": ""
 355           }
 356         ]
 357       }
 358     },
 359     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 360     "version": "0.0.0",
 361     "filename": "server/api/analyticDefaultReport/index.js",
 362     "groupTitle": "Analytic_Default_Reports"
 363   },
 364   {
 365     "type": "delete",
 366     "url": "/api/analytics/default_reports/{id}",
 367     "title": "Deletes a Analytic Default Report",
 368     "examples": [
 369       {
 370         "title": "Example usage:",
 371         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 372         "type": "json"
 373       }
 374     ],
 375     "name": "DeleteAnalytic_Default_Reports",
 376     "group": "Analytic_Default_Reports",
 377     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 378     "version": "0.0.0",
 379     "filename": "server/api/analyticDefaultReport/index.js",
 380     "groupTitle": "Analytic_Default_Reports"
 381   },
 382   {
 383     "type": "get",
 384     "url": "/api/analytics/default_reports",
 385     "title": "Gets a list of Analytic Default Reports",
 386     "examples": [
 387       {
 388         "title": "Example usage:",
 389         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 390         "type": "json"
 391       }
 392     ],
 393     "name": "GetAnalytic_Default_Reports",
 394     "group": "Analytic_Default_Reports",
 395     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 396     "version": "0.0.0",
 397     "filename": "server/api/analyticDefaultReport/index.js",
 398     "groupTitle": "Analytic_Default_Reports"
 399   },
 400   {
 401     "type": "get",
 402     "url": "/api/analytics/default_reports/{id}",
 403     "title": "Gets a single Analytic Default Report",
 404     "examples": [
 405       {
 406         "title": "Example usage:",
 407         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 408         "type": "json"
 409       }
 410     ],
 411     "name": "ShowAnalytic_Default_Reports",
 412     "group": "Analytic_Default_Reports",
 413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 414     "version": "0.0.0",
 415     "filename": "server/api/analyticDefaultReport/index.js",
 416     "groupTitle": "Analytic_Default_Reports"
 417   },
 418   {
 419     "type": "get",
 420     "url": "/api/analytics/default_reports/{id}/preview",
 421     "title": "Report Preview",
 422     "examples": [
 423       {
 424         "title": "Example usage:",
 425         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 426         "type": "json"
 427       }
 428     ],
 429     "name": "preview",
 430     "group": "Analytic_Default_Reports",
 431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 432     "version": "0.0.0",
 433     "filename": "server/api/analyticDefaultReport/index.js",
 434     "groupTitle": "Analytic_Default_Reports"
 435   },
 436   {
 437     "type": "get",
 438     "url": "/api/analytics/default_reports/{id}/query",
 439     "title": "Report Query SQL",
 440     "examples": [
 441       {
 442         "title": "Example usage:",
 443         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 444         "type": "json"
 445       }
 446     ],
 447     "name": "query",
 448     "group": "Analytic_Default_Reports",
 449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 450     "version": "0.0.0",
 451     "filename": "server/api/analyticDefaultReport/index.js",
 452     "groupTitle": "Analytic_Default_Reports"
 453   },
 454   {
 455     "type": "get",
 456     "url": "/api/analytics/default_reports/{id}/run",
 457     "title": "Report Run",
 458     "examples": [
 459       {
 460         "title": "Example usage:",
 461         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 462         "type": "json"
 463       }
 464     ],
 465     "name": "run",
 466     "group": "Analytic_Default_Reports",
 467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 468     "version": "0.0.0",
 469     "filename": "server/api/analyticDefaultReport/index.js",
 470     "groupTitle": "Analytic_Default_Reports"
 471   },
 472   {
 473     "type": "put",
 474     "url": "/api/analytics/default_reports/{id}",
 475     "title": "Update an existing Analytic Default Report",
 476     "examples": [
 477       {
 478         "title": "Example usage:",
 479         "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",
 480         "type": "json"
 481       }
 482     ],
 483     "name": "updateAnalytic_Default_Reports",
 484     "group": "Analytic_Default_Reports",
 485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 486     "version": "0.0.0",
 487     "filename": "server/api/analyticDefaultReport/index.js",
 488     "groupTitle": "Analytic_Default_Reports"
 489   },
 490   {
 491     "type": "post",
 492     "url": "/api/analytics/extracted_reports",
 493     "title": "Creates a new Analytic Extracted Report",
 494     "examples": [
 495       {
 496         "title": "Example usage:",
 497         "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",
 498         "type": "json"
 499       }
 500     ],
 501     "name": "CreateAnalytic_Extacted_Reports",
 502     "group": "Analytic_Extracted_Reports",
 503     "parameter": {
 504       "fields": {
 505         "Body": [
 506           {
 507             "group": "Body",
 508             "type": "String",
 509             "optional": false,
 510             "field": "name",
 511             "description": ""
 512           },
 513           {
 514             "group": "Body",
 515             "type": "String",
 516             "optional": false,
 517             "field": "basename",
 518             "description": ""
 519           },
 520           {
 521             "group": "Body",
 522             "type": "String",
 523             "allowedValues": [
 524               "\"csv\"",
 525               "\"pdf\"",
 526               "\"xlsx\""
 527             ],
 528             "optional": false,
 529             "field": "output",
 530             "description": ""
 531           },
 532           {
 533             "group": "Body",
 534             "type": "String",
 535             "optional": false,
 536             "field": "savename",
 537             "description": ""
 538           },
 539           {
 540             "group": "Body",
 541             "type": "String",
 542             "optional": true,
 543             "field": "startDate",
 544             "description": ""
 545           },
 546           {
 547             "group": "Body",
 548             "type": "String",
 549             "optional": true,
 550             "field": "endDate",
 551             "description": ""
 552           },
 553           {
 554             "group": "Body",
 555             "type": "String",
 556             "optional": true,
 557             "field": "status",
 558             "description": ""
 559           },
 560           {
 561             "group": "Body",
 562             "type": "String",
 563             "allowedValues": [
 564               "\"manual\"",
 565               "\"scheduled\""
 566             ],
 567             "optional": false,
 568             "field": "type",
 569             "description": ""
 570           },
 571           {
 572             "group": "Body",
 573             "type": "Integer",
 574             "optional": true,
 575             "field": "reportId",
 576             "description": ""
 577           },
 578           {
 579             "group": "Body",
 580             "type": "String",
 581             "optional": true,
 582             "field": "reportType",
 583             "description": ""
 584           }
 585         ]
 586       }
 587     },
 588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 589     "version": "0.0.0",
 590     "filename": "server/api/analyticExtractedReport/index.js",
 591     "groupTitle": "Analytic_Extracted_Reports"
 592   },
 593   {
 594     "type": "delete",
 595     "url": "/api/analytics/extracted_reports/{id}",
 596     "title": "Deletes a Analytic Extracted Report",
 597     "examples": [
 598       {
 599         "title": "Example usage:",
 600         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 601         "type": "json"
 602       }
 603     ],
 604     "name": "DeleteAnalytic_Extacted_Reports",
 605     "group": "Analytic_Extracted_Reports",
 606     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 607     "version": "0.0.0",
 608     "filename": "server/api/analyticExtractedReport/index.js",
 609     "groupTitle": "Analytic_Extracted_Reports"
 610   },
 611   {
 612     "type": "get",
 613     "url": "/api/analytics/extracted_reports",
 614     "title": "Gets a list of Analytic Extacted Reports",
 615     "examples": [
 616       {
 617         "title": "Example usage:",
 618         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 619         "type": "json"
 620       }
 621     ],
 622     "name": "GetAnalytic_Extacted_Reports",
 623     "group": "Analytic_Extracted_Reports",
 624     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 625     "version": "0.0.0",
 626     "filename": "server/api/analyticExtractedReport/index.js",
 627     "groupTitle": "Analytic_Extracted_Reports"
 628   },
 629   {
 630     "type": "get",
 631     "url": "/api/analytics/extracted_reports/{id}",
 632     "title": "Gets a single Analytic Extracted Report",
 633     "examples": [
 634       {
 635         "title": "Example usage:",
 636         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 637         "type": "json"
 638       }
 639     ],
 640     "name": "ShowAnalytic_Extacted_Reports",
 641     "group": "Analytic_Extracted_Reports",
 642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 643     "version": "0.0.0",
 644     "filename": "server/api/analyticExtractedReport/index.js",
 645     "groupTitle": "Analytic_Extracted_Reports"
 646   },
 647   {
 648     "type": "get",
 649     "url": "/api/analytics/extracted_reports/{id}/download",
 650     "title": "Download Extracted Report",
 651     "examples": [
 652       {
 653         "title": "Example usage:",
 654         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 655         "type": "json"
 656       }
 657     ],
 658     "name": "download",
 659     "group": "Analytic_Extracted_Reports",
 660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 661     "version": "0.0.0",
 662     "filename": "server/api/analyticExtractedReport/index.js",
 663     "groupTitle": "Analytic_Extracted_Reports"
 664   },
 665   {
 666     "type": "put",
 667     "url": "/api/analytics/extracted_reports/{id}",
 668     "title": "Update an existing Analytic Extracted Report",
 669     "examples": [
 670       {
 671         "title": "Example usage:",
 672         "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",
 673         "type": "json"
 674       }
 675     ],
 676     "name": "updateAnalytic_Extacted_Reports",
 677     "group": "Analytic_Extracted_Reports",
 678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 679     "version": "0.0.0",
 680     "filename": "server/api/analyticExtractedReport/index.js",
 681     "groupTitle": "Analytic_Extracted_Reports"
 682   },
 683   {
 684     "type": "post",
 685     "url": "/api/analytics/field_reports/create_many",
 686     "title": "Creates many Analytic Field Reports",
 687     "examples": [
 688       {
 689         "title": "Example usage:",
 690         "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",
 691         "type": "json"
 692       }
 693     ],
 694     "name": "BulkCreateAnalytic_Field_Reports",
 695     "group": "Analytic_Field_Reports",
 696     "parameter": {
 697       "fields": {
 698         "Body": [
 699           {
 700             "group": "Body",
 701             "type": "Text",
 702             "optional": true,
 703             "field": "field",
 704             "description": ""
 705           },
 706           {
 707             "group": "Body",
 708             "type": "String",
 709             "optional": true,
 710             "field": "alias",
 711             "description": ""
 712           },
 713           {
 714             "group": "Body",
 715             "type": "String",
 716             "optional": true,
 717             "field": "function",
 718             "description": ""
 719           },
 720           {
 721             "group": "Body",
 722             "type": "String",
 723             "optional": true,
 724             "field": "format",
 725             "description": ""
 726           },
 727           {
 728             "group": "Body",
 729             "type": "Boolean",
 730             "optional": true,
 731             "field": "groupBy",
 732             "description": ""
 733           },
 734           {
 735             "group": "Body",
 736             "type": "String",
 737             "optional": true,
 738             "field": "orderBy",
 739             "description": ""
 740           },
 741           {
 742             "group": "Body",
 743             "type": "Boolean",
 744             "optional": true,
 745             "field": "custom",
 746             "description": ""
 747           }
 748         ]
 749       }
 750     },
 751     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 752     "version": "0.0.0",
 753     "filename": "server/api/analyticFieldReport/index.js",
 754     "groupTitle": "Analytic_Field_Reports"
 755   },
 756   {
 757     "type": "delete",
 758     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 759     "title": "Deletes many Analytic Field Reports",
 760     "examples": [
 761       {
 762         "title": "Example usage:",
 763         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 764         "type": "json"
 765       }
 766     ],
 767     "name": "BulkDeleteAnalytic_Field_Reports",
 768     "group": "Analytic_Field_Reports",
 769     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 770     "version": "0.0.0",
 771     "filename": "server/api/analyticFieldReport/index.js",
 772     "groupTitle": "Analytic_Field_Reports"
 773   },
 774   {
 775     "type": "post",
 776     "url": "/api/analytics/field_reports",
 777     "title": "Creates a new Analytic Field Report",
 778     "examples": [
 779       {
 780         "title": "Example usage:",
 781         "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",
 782         "type": "json"
 783       }
 784     ],
 785     "name": "CreateAnalytic_Field_Reports",
 786     "group": "Analytic_Field_Reports",
 787     "parameter": {
 788       "fields": {
 789         "Body": [
 790           {
 791             "group": "Body",
 792             "type": "Text",
 793             "optional": true,
 794             "field": "field",
 795             "description": ""
 796           },
 797           {
 798             "group": "Body",
 799             "type": "String",
 800             "optional": true,
 801             "field": "alias",
 802             "description": ""
 803           },
 804           {
 805             "group": "Body",
 806             "type": "String",
 807             "optional": true,
 808             "field": "function",
 809             "description": ""
 810           },
 811           {
 812             "group": "Body",
 813             "type": "String",
 814             "optional": true,
 815             "field": "format",
 816             "description": ""
 817           },
 818           {
 819             "group": "Body",
 820             "type": "Boolean",
 821             "optional": true,
 822             "field": "groupBy",
 823             "description": ""
 824           },
 825           {
 826             "group": "Body",
 827             "type": "String",
 828             "optional": true,
 829             "field": "orderBy",
 830             "description": ""
 831           },
 832           {
 833             "group": "Body",
 834             "type": "Boolean",
 835             "optional": true,
 836             "field": "custom",
 837             "description": ""
 838           }
 839         ]
 840       }
 841     },
 842     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 843     "version": "0.0.0",
 844     "filename": "server/api/analyticFieldReport/index.js",
 845     "groupTitle": "Analytic_Field_Reports"
 846   },
 847   {
 848     "type": "delete",
 849     "url": "/api/analytics/field_reports/{id}",
 850     "title": "Deletes a Analytic Field Report",
 851     "examples": [
 852       {
 853         "title": "Example usage:",
 854         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 855         "type": "json"
 856       }
 857     ],
 858     "name": "DeleteAnalytic_Field_Reports",
 859     "group": "Analytic_Field_Reports",
 860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 861     "version": "0.0.0",
 862     "filename": "server/api/analyticFieldReport/index.js",
 863     "groupTitle": "Analytic_Field_Reports"
 864   },
 865   {
 866     "type": "get",
 867     "url": "/api/analytics/field_reports",
 868     "title": "Gets a list of Analytic Field Reports",
 869     "examples": [
 870       {
 871         "title": "Example usage:",
 872         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 873         "type": "json"
 874       }
 875     ],
 876     "name": "GetAnalytic_Field_Reports",
 877     "group": "Analytic_Field_Reports",
 878     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 879     "version": "0.0.0",
 880     "filename": "server/api/analyticFieldReport/index.js",
 881     "groupTitle": "Analytic_Field_Reports"
 882   },
 883   {
 884     "type": "get",
 885     "url": "/api/analytics/field_reports/{id}",
 886     "title": "Gets a single Analytic Field Report",
 887     "examples": [
 888       {
 889         "title": "Example usage:",
 890         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 891         "type": "json"
 892       }
 893     ],
 894     "name": "ShowAnalytic_Field_Reports",
 895     "group": "Analytic_Field_Reports",
 896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 897     "version": "0.0.0",
 898     "filename": "server/api/analyticFieldReport/index.js",
 899     "groupTitle": "Analytic_Field_Reports"
 900   },
 901   {
 902     "type": "post",
 903     "url": "/api/analytics/field_reports/{id}/create_many",
 904     "title": "Rewrite fields set",
 905     "examples": [
 906       {
 907         "title": "Example usage:",
 908         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 909         "type": "json"
 910       }
 911     ],
 912     "name": "addFields",
 913     "group": "Analytic_Field_Reports",
 914     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 915     "version": "0.0.0",
 916     "filename": "server/api/analyticFieldReport/index.js",
 917     "groupTitle": "Analytic_Field_Reports"
 918   },
 919   {
 920     "type": "put",
 921     "url": "/api/analytics/field_reports/{id}",
 922     "title": "Update an existing Analytic Field Report",
 923     "examples": [
 924       {
 925         "title": "Example usage:",
 926         "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",
 927         "type": "json"
 928       }
 929     ],
 930     "name": "updateAnalytic_Field_Reports",
 931     "group": "Analytic_Field_Reports",
 932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 933     "version": "0.0.0",
 934     "filename": "server/api/analyticFieldReport/index.js",
 935     "groupTitle": "Analytic_Field_Reports"
 936   },
 937   {
 938     "type": "post",
 939     "url": "/api/analytics/metrics",
 940     "title": "Creates a new Analytic Metrics",
 941     "examples": [
 942       {
 943         "title": "Example usage:",
 944         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 945         "type": "json"
 946       }
 947     ],
 948     "name": "CreateAnalytic_Metric",
 949     "group": "Analytic_Metrics",
 950     "parameter": {
 951       "fields": {
 952         "Body": [
 953           {
 954             "group": "Body",
 955             "type": "String",
 956             "optional": false,
 957             "field": "name",
 958             "description": ""
 959           },
 960           {
 961             "group": "Body",
 962             "type": "String",
 963             "optional": true,
 964             "field": "table",
 965             "description": ""
 966           },
 967           {
 968             "group": "Body",
 969             "type": "Text",
 970             "optional": true,
 971             "field": "metric",
 972             "description": ""
 973           },
 974           {
 975             "group": "Body",
 976             "type": "String",
 977             "optional": true,
 978             "field": "description",
 979             "description": ""
 980           }
 981         ]
 982       }
 983     },
 984     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 985     "version": "0.0.0",
 986     "filename": "server/api/analyticMetric/index.js",
 987     "groupTitle": "Analytic_Metrics"
 988   },
 989   {
 990     "type": "delete",
 991     "url": "/api/analytics/metrics/{id}",
 992     "title": "Deletes a Analytic Metrics",
 993     "examples": [
 994       {
 995         "title": "Example usage:",
 996         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 997         "type": "json"
 998       }
 999     ],
1000     "name": "DeleteAnalytic_Metric",
1001     "group": "Analytic_Metrics",
1002     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1003     "version": "0.0.0",
1004     "filename": "server/api/analyticMetric/index.js",
1005     "groupTitle": "Analytic_Metrics"
1006   },
1007   {
1008     "type": "get",
1009     "url": "/api/analytics/metrics",
1010     "title": "Gets a list of Analytic Metric",
1011     "examples": [
1012       {
1013         "title": "Example usage:",
1014         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
1015         "type": "json"
1016       }
1017     ],
1018     "name": "GetAnalytic_Metric",
1019     "group": "Analytic_Metrics",
1020     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1021     "version": "0.0.0",
1022     "filename": "server/api/analyticMetric/index.js",
1023     "groupTitle": "Analytic_Metrics"
1024   },
1025   {
1026     "type": "get",
1027     "url": "/api/analytics/metrics/{id}",
1028     "title": "Gets a single Analytic Metrics",
1029     "examples": [
1030       {
1031         "title": "Example usage:",
1032         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
1033         "type": "json"
1034       }
1035     ],
1036     "name": "ShowAnalytic_Metric",
1037     "group": "Analytic_Metrics",
1038     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039     "version": "0.0.0",
1040     "filename": "server/api/analyticMetric/index.js",
1041     "groupTitle": "Analytic_Metrics"
1042   },
1043   {
1044     "type": "put",
1045     "url": "/api/analytics/metrics/{id}",
1046     "title": "Update an existing Analytic Metrics",
1047     "examples": [
1048       {
1049         "title": "Example usage:",
1050         "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",
1051         "type": "json"
1052       }
1053     ],
1054     "name": "updateAnalytic_Metric",
1055     "group": "Analytic_Metrics",
1056     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1057     "version": "0.0.0",
1058     "filename": "server/api/analyticMetric/index.js",
1059     "groupTitle": "Analytic_Metrics"
1060   },
1061   {
1062     "type": "post",
1063     "url": "/api/analytics/tree_reports",
1064     "title": "Creates a new Analytic Tree Report",
1065     "examples": [
1066       {
1067         "title": "Example usage:",
1068         "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",
1069         "type": "json"
1070       }
1071     ],
1072     "name": "CreateAnalytic_Tree_Reports",
1073     "group": "Analytic_Tree_Reports",
1074     "parameter": {
1075       "fields": {
1076         "Body": [
1077           {
1078             "group": "Body",
1079             "type": "Text",
1080             "optional": false,
1081             "field": "tree",
1082             "description": ""
1083           }
1084         ]
1085       }
1086     },
1087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1088     "version": "0.0.0",
1089     "filename": "server/api/analyticTreeReport/index.js",
1090     "groupTitle": "Analytic_Tree_Reports"
1091   },
1092   {
1093     "type": "delete",
1094     "url": "/api/analytics/tree_reports/{id}",
1095     "title": "Deletes a Analytic Tree Report",
1096     "examples": [
1097       {
1098         "title": "Example usage:",
1099         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1100         "type": "json"
1101       }
1102     ],
1103     "name": "DeleteAnalytic_Tree_Reports",
1104     "group": "Analytic_Tree_Reports",
1105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1106     "version": "0.0.0",
1107     "filename": "server/api/analyticTreeReport/index.js",
1108     "groupTitle": "Analytic_Tree_Reports"
1109   },
1110   {
1111     "type": "get",
1112     "url": "/api/analytics/tree_reports",
1113     "title": "Gets a list of Analytic Tree Reports",
1114     "examples": [
1115       {
1116         "title": "Example usage:",
1117         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1118         "type": "json"
1119       }
1120     ],
1121     "name": "GetAnalytic_Tree_Reports",
1122     "group": "Analytic_Tree_Reports",
1123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1124     "version": "0.0.0",
1125     "filename": "server/api/analyticTreeReport/index.js",
1126     "groupTitle": "Analytic_Tree_Reports"
1127   },
1128   {
1129     "type": "get",
1130     "url": "/api/analytics/tree_reports/{id}",
1131     "title": "Gets a single Analytic Tree Report",
1132     "examples": [
1133       {
1134         "title": "Example usage:",
1135         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1136         "type": "json"
1137       }
1138     ],
1139     "name": "ShowAnalytic_Tree_Reports",
1140     "group": "Analytic_Tree_Reports",
1141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1142     "version": "0.0.0",
1143     "filename": "server/api/analyticTreeReport/index.js",
1144     "groupTitle": "Analytic_Tree_Reports"
1145   },
1146   {
1147     "type": "put",
1148     "url": "/api/analytics/tree_reports/{id}",
1149     "title": "Update an existing Analytic Tree Report",
1150     "examples": [
1151       {
1152         "title": "Example usage:",
1153         "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",
1154         "type": "json"
1155       }
1156     ],
1157     "name": "updateAnalytic_Tree_Reports",
1158     "group": "Analytic_Tree_Reports",
1159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1160     "version": "0.0.0",
1161     "filename": "server/api/analyticTreeReport/index.js",
1162     "groupTitle": "Analytic_Tree_Reports"
1163   },
1164   {
1165     "type": "post",
1166     "url": "/api/attachments/clone",
1167     "title": "Clone an existing Attachment",
1168     "examples": [
1169       {
1170         "title": "Example usage:",
1171         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1172         "type": "json"
1173       }
1174     ],
1175     "name": "CloneAttachments",
1176     "group": "Attachments",
1177     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1178     "version": "0.0.0",
1179     "filename": "server/api/attachment/index.js",
1180     "groupTitle": "Attachments"
1181   },
1182   {
1183     "type": "delete",
1184     "url": "/api/attachments/{id}",
1185     "title": "Deletes a Attachment",
1186     "examples": [
1187       {
1188         "title": "Example usage:",
1189         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1190         "type": "json"
1191       }
1192     ],
1193     "name": "DeleteAttachments",
1194     "group": "Attachments",
1195     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1196     "version": "0.0.0",
1197     "filename": "server/api/attachment/index.js",
1198     "groupTitle": "Attachments"
1199   },
1200   {
1201     "type": "get",
1202     "url": "/api/attachments",
1203     "title": "Gets a list of Attachments",
1204     "examples": [
1205       {
1206         "title": "Example usage:",
1207         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1208         "type": "json"
1209       }
1210     ],
1211     "name": "GetAttachments",
1212     "group": "Attachments",
1213     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1214     "version": "0.0.0",
1215     "filename": "server/api/attachment/index.js",
1216     "groupTitle": "Attachments"
1217   },
1218   {
1219     "type": "get",
1220     "url": "/api/attachments/{id}",
1221     "title": "Gets a single Attachment",
1222     "examples": [
1223       {
1224         "title": "Example usage:",
1225         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1226         "type": "json"
1227       }
1228     ],
1229     "name": "ShowAttachments",
1230     "group": "Attachments",
1231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1232     "version": "0.0.0",
1233     "filename": "server/api/attachment/index.js",
1234     "groupTitle": "Attachments"
1235   },
1236   {
1237     "type": "post",
1238     "url": "/api/attachments",
1239     "title": "Add attachment",
1240     "examples": [
1241       {
1242         "title": "Example usage:",
1243         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1244         "type": "json"
1245       }
1246     ],
1247     "name": "create",
1248     "group": "Attachments",
1249     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1250     "version": "0.0.0",
1251     "filename": "server/api/attachment/index.js",
1252     "groupTitle": "Attachments"
1253   },
1254   {
1255     "type": "get",
1256     "url": "/api/attachments/:id/download",
1257     "title": "Download attachment",
1258     "examples": [
1259       {
1260         "title": "Example usage:",
1261         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1262         "type": "json"
1263       }
1264     ],
1265     "name": "download",
1266     "group": "Attachments",
1267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268     "version": "0.0.0",
1269     "filename": "server/api/attachment/index.js",
1270     "groupTitle": "Attachments"
1271   },
1272   {
1273     "type": "get",
1274     "url": "/api/chat/interactions/{id}/attachment_download",
1275     "title": "Download attachment",
1276     "examples": [
1277       {
1278         "title": "Example usage:",
1279         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1280         "type": "json"
1281       }
1282     ],
1283     "name": "show",
1284     "group": "Attachments",
1285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1286     "version": "0.0.0",
1287     "filename": "server/api/chatInteraction/index.js",
1288     "groupTitle": "Attachments"
1289   },
1290   {
1291     "type": "put",
1292     "url": "/api/attachments/{id}",
1293     "title": "Update an existing Attachment",
1294     "examples": [
1295       {
1296         "title": "Example usage:",
1297         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1298         "type": "json"
1299       }
1300     ],
1301     "name": "updateAttachments",
1302     "group": "Attachments",
1303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1304     "version": "0.0.0",
1305     "filename": "server/api/attachment/index.js",
1306     "groupTitle": "Attachments"
1307   },
1308   {
1309     "type": "post",
1310     "url": "/api/auth/local/forgot",
1311     "title": "Creates a new password reset token",
1312     "examples": [
1313       {
1314         "title": "Example usage:",
1315         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1316         "type": "json"
1317       }
1318     ],
1319     "name": "Local_Forgot_Password",
1320     "group": "Authentication",
1321     "parameter": {
1322       "fields": {
1323         "Body": [
1324           {
1325             "group": "Body",
1326             "type": "String",
1327             "optional": false,
1328             "field": "email",
1329             "description": ""
1330           }
1331         ]
1332       }
1333     },
1334     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1335     "version": "0.0.0",
1336     "filename": "server/api/authLocal/index.js",
1337     "groupTitle": "Authentication"
1338   },
1339   {
1340     "type": "post",
1341     "url": "/api/auth/local/reset/:token",
1342     "title": "Reset user password",
1343     "examples": [
1344       {
1345         "title": "Example usage:",
1346         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1347         "type": "json"
1348       }
1349     ],
1350     "name": "Local_Reset_Password",
1351     "group": "Authentication",
1352     "parameter": {
1353       "fields": {
1354         "Body": [
1355           {
1356             "group": "Body",
1357             "type": "String",
1358             "optional": false,
1359             "field": "password",
1360             "description": ""
1361           }
1362         ]
1363       }
1364     },
1365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1366     "version": "0.0.0",
1367     "filename": "server/api/authLocal/index.js",
1368     "groupTitle": "Authentication"
1369   },
1370   {
1371     "type": "post",
1372     "url": "/api/auth/activedirectory",
1373     "title": "Creates a new User token",
1374     "examples": [
1375       {
1376         "title": "Example usage:",
1377         "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1378         "type": "json"
1379       }
1380     ],
1381     "name": "Local_login",
1382     "group": "Authentication",
1383     "parameter": {
1384       "fields": {
1385         "Body": [
1386           {
1387             "group": "Body",
1388             "type": "String",
1389             "optional": false,
1390             "field": "name",
1391             "description": ""
1392           },
1393           {
1394             "group": "Body",
1395             "type": "String",
1396             "optional": false,
1397             "field": "password",
1398             "description": ""
1399           }
1400         ]
1401       }
1402     },
1403     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1404     "version": "0.0.0",
1405     "filename": "server/api/authActiveDirectory/index.js",
1406     "groupTitle": "Authentication"
1407   },
1408   {
1409     "type": "post",
1410     "url": "/api/auth/google",
1411     "title": "Creates a new User token",
1412     "examples": [
1413       {
1414         "title": "Example usage:",
1415         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1416         "type": "json"
1417       }
1418     ],
1419     "name": "Local_login",
1420     "group": "Authentication",
1421     "parameter": {
1422       "fields": {
1423         "Body": [
1424           {
1425             "group": "Body",
1426             "type": "String",
1427             "optional": false,
1428             "field": "name",
1429             "description": ""
1430           },
1431           {
1432             "group": "Body",
1433             "type": "String",
1434             "optional": false,
1435             "field": "password",
1436             "description": ""
1437           }
1438         ]
1439       }
1440     },
1441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1442     "version": "0.0.0",
1443     "filename": "server/api/authGoogle/index.js",
1444     "groupTitle": "Authentication"
1445   },
1446   {
1447     "type": "post",
1448     "url": "/api/auth/local",
1449     "title": "Creates a new User token",
1450     "examples": [
1451       {
1452         "title": "Example usage:",
1453         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1454         "type": "json"
1455       }
1456     ],
1457     "name": "Local_login",
1458     "group": "Authentication",
1459     "parameter": {
1460       "fields": {
1461         "Body": [
1462           {
1463             "group": "Body",
1464             "type": "String",
1465             "optional": false,
1466             "field": "name",
1467             "description": ""
1468           },
1469           {
1470             "group": "Body",
1471             "type": "String",
1472             "optional": false,
1473             "field": "password",
1474             "description": ""
1475           }
1476         ]
1477       }
1478     },
1479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1480     "version": "0.0.0",
1481     "filename": "server/api/authLocal/index.js",
1482     "groupTitle": "Authentication"
1483   },
1484   {
1485     "type": "post",
1486     "url": "/api/automations",
1487     "title": "Creates a new Automation",
1488     "examples": [
1489       {
1490         "title": "Example usage:",
1491         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1492         "type": "json"
1493       }
1494     ],
1495     "name": "CreateAutomations",
1496     "group": "Automations",
1497     "parameter": {
1498       "fields": {
1499         "Body": [
1500           {
1501             "group": "Body",
1502             "type": "String",
1503             "optional": false,
1504             "field": "name",
1505             "description": ""
1506           },
1507           {
1508             "group": "Body",
1509             "type": "String",
1510             "optional": true,
1511             "field": "channel",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": true,
1518             "field": "description",
1519             "description": ""
1520           },
1521           {
1522             "group": "Body",
1523             "type": "Boolean",
1524             "optional": true,
1525             "field": "status",
1526             "description": ""
1527           },
1528           {
1529             "group": "Body",
1530             "type": "Integer",
1531             "optional": true,
1532             "field": "timeout",
1533             "description": ""
1534           }
1535         ]
1536       }
1537     },
1538     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1539     "version": "0.0.0",
1540     "filename": "server/api/automation/index.js",
1541     "groupTitle": "Automations"
1542   },
1543   {
1544     "type": "delete",
1545     "url": "/api/automations/{id}",
1546     "title": "Deletes a Automation",
1547     "examples": [
1548       {
1549         "title": "Example usage:",
1550         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1551         "type": "json"
1552       }
1553     ],
1554     "name": "DeleteAutomations",
1555     "group": "Automations",
1556     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1557     "version": "0.0.0",
1558     "filename": "server/api/automation/index.js",
1559     "groupTitle": "Automations"
1560   },
1561   {
1562     "type": "get",
1563     "url": "/api/automations",
1564     "title": "Gets a list of Automations",
1565     "examples": [
1566       {
1567         "title": "Example usage:",
1568         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1569         "type": "json"
1570       }
1571     ],
1572     "name": "GetAutomations",
1573     "group": "Automations",
1574     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1575     "version": "0.0.0",
1576     "filename": "server/api/automation/index.js",
1577     "groupTitle": "Automations"
1578   },
1579   {
1580     "type": "get",
1581     "url": "/api/automations/{id}",
1582     "title": "Gets a single Automation",
1583     "examples": [
1584       {
1585         "title": "Example usage:",
1586         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1587         "type": "json"
1588       }
1589     ],
1590     "name": "ShowAutomations",
1591     "group": "Automations",
1592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1593     "version": "0.0.0",
1594     "filename": "server/api/automation/index.js",
1595     "groupTitle": "Automations"
1596   },
1597   {
1598     "type": "post",
1599     "url": "/api/automations/{id}/actions",
1600     "title": "Creates new actions",
1601     "examples": [
1602       {
1603         "title": "Example usage:",
1604         "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",
1605         "type": "json"
1606       }
1607     ],
1608     "name": "addActions",
1609     "group": "Automations",
1610     "parameter": {
1611       "fields": {
1612         "Body": [
1613           {
1614             "group": "Body",
1615             "type": "Virtual",
1616             "optional": true,
1617             "field": "name",
1618             "description": ""
1619           },
1620           {
1621             "group": "Body",
1622             "type": "String",
1623             "optional": false,
1624             "field": "action",
1625             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1626           },
1627           {
1628             "group": "Body",
1629             "type": "String",
1630             "optional": true,
1631             "field": "data1",
1632             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1633           },
1634           {
1635             "group": "Body",
1636             "type": "String",
1637             "optional": true,
1638             "field": "data2",
1639             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1640           },
1641           {
1642             "group": "Body",
1643             "type": "String",
1644             "optional": true,
1645             "field": "data3",
1646             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1647           },
1648           {
1649             "group": "Body",
1650             "type": "String",
1651             "optional": true,
1652             "field": "data4",
1653             "description": ""
1654           },
1655           {
1656             "group": "Body",
1657             "type": "String",
1658             "optional": true,
1659             "field": "data5",
1660             "description": ""
1661           },
1662           {
1663             "group": "Body",
1664             "type": "String",
1665             "optional": true,
1666             "field": "data6",
1667             "description": ""
1668           },
1669           {
1670             "group": "Body",
1671             "type": "Text",
1672             "optional": true,
1673             "field": "data7",
1674             "description": ""
1675           }
1676         ]
1677       }
1678     },
1679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/automations/{id}/conditions",
1687     "title": "Creates new conditions",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "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",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "addConditions",
1696     "group": "Automations",
1697     "parameter": {
1698       "fields": {
1699         "Body": [
1700           {
1701             "group": "Body",
1702             "type": "Virtual",
1703             "optional": true,
1704             "field": "name",
1705             "description": ""
1706           },
1707           {
1708             "group": "Body",
1709             "type": "String",
1710             "optional": false,
1711             "field": "field",
1712             "description": ""
1713           },
1714           {
1715             "group": "Body",
1716             "type": "String",
1717             "optional": false,
1718             "field": "operator",
1719             "description": ""
1720           },
1721           {
1722             "group": "Body",
1723             "type": "String",
1724             "optional": false,
1725             "field": "value",
1726             "description": ""
1727           }
1728         ]
1729       }
1730     },
1731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1732     "version": "0.0.0",
1733     "filename": "server/api/automation/index.js",
1734     "groupTitle": "Automations"
1735   },
1736   {
1737     "type": "get",
1738     "url": "/api/automations/{id}/actions",
1739     "title": "Gets Automation Actions",
1740     "examples": [
1741       {
1742         "title": "Example usage:",
1743         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1744         "type": "json"
1745       }
1746     ],
1747     "name": "getActions",
1748     "group": "Automations",
1749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1750     "version": "0.0.0",
1751     "filename": "server/api/automation/index.js",
1752     "groupTitle": "Automations"
1753   },
1754   {
1755     "type": "get",
1756     "url": "/api/automations/{id}/conditions",
1757     "title": "Gets Automation Conditions",
1758     "examples": [
1759       {
1760         "title": "Example usage:",
1761         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1762         "type": "json"
1763       }
1764     ],
1765     "name": "getConditions",
1766     "group": "Automations",
1767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1768     "version": "0.0.0",
1769     "filename": "server/api/automation/index.js",
1770     "groupTitle": "Automations"
1771   },
1772   {
1773     "type": "put",
1774     "url": "/api/automations/{id}",
1775     "title": "Update an existing Automation",
1776     "examples": [
1777       {
1778         "title": "Example usage:",
1779         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1780         "type": "json"
1781       }
1782     ],
1783     "name": "updateAutomations",
1784     "group": "Automations",
1785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1786     "version": "0.0.0",
1787     "filename": "server/api/automation/index.js",
1788     "groupTitle": "Automations"
1789   },
1790   {
1791     "type": "post",
1792     "url": "/api/canned_answers",
1793     "title": "Create a new canned answer",
1794     "examples": [
1795       {
1796         "title": "Example usage:",
1797         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1798         "type": "json"
1799       }
1800     ],
1801     "name": "Create",
1802     "group": "Canned_Answers",
1803     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1804     "version": "0.0.0",
1805     "filename": "server/api/cannedAnswer/index.js",
1806     "groupTitle": "Canned_Answers"
1807   },
1808   {
1809     "type": "delete",
1810     "url": "/api/canned_answers/{id}",
1811     "title": "Deletes a Canned Answer",
1812     "examples": [
1813       {
1814         "title": "Example usage:",
1815         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1816         "type": "json"
1817       }
1818     ],
1819     "name": "DeleteCanned_Answers",
1820     "group": "Canned_Answers",
1821     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1822     "version": "0.0.0",
1823     "filename": "server/api/cannedAnswer/index.js",
1824     "groupTitle": "Canned_Answers"
1825   },
1826   {
1827     "type": "get",
1828     "url": "/api/canned_answers",
1829     "title": "Gets a list of Canned Answers",
1830     "examples": [
1831       {
1832         "title": "Example usage:",
1833         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1834         "type": "json"
1835       }
1836     ],
1837     "name": "GetCanned_Answers",
1838     "group": "Canned_Answers",
1839     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1840     "version": "0.0.0",
1841     "filename": "server/api/cannedAnswer/index.js",
1842     "groupTitle": "Canned_Answers"
1843   },
1844   {
1845     "type": "get",
1846     "url": "/api/canned_answers/{id}",
1847     "title": "Gets a single Canned Answer",
1848     "examples": [
1849       {
1850         "title": "Example usage:",
1851         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1852         "type": "json"
1853       }
1854     ],
1855     "name": "ShowCanned_Answers",
1856     "group": "Canned_Answers",
1857     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1858     "version": "0.0.0",
1859     "filename": "server/api/cannedAnswer/index.js",
1860     "groupTitle": "Canned_Answers"
1861   },
1862   {
1863     "type": "put",
1864     "url": "/api/canned_answers/{id}",
1865     "title": "Update an existing Canned Answer",
1866     "examples": [
1867       {
1868         "title": "Example usage:",
1869         "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",
1870         "type": "json"
1871       }
1872     ],
1873     "name": "updateCanned_Answers",
1874     "group": "Canned_Answers",
1875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1876     "version": "0.0.0",
1877     "filename": "server/api/cannedAnswer/index.js",
1878     "groupTitle": "Canned_Answers"
1879   },
1880   {
1881     "type": "get",
1882     "url": "/chat/internal/users",
1883     "title": "Gets Users Last Messages",
1884     "examples": [
1885       {
1886         "title": "Example usage:",
1887         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1888         "type": "json"
1889       }
1890     ],
1891     "name": "getLastUsersMessages",
1892     "group": "ChatInternalMessage",
1893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1894     "version": "0.0.0",
1895     "filename": "server/api/chatInternalMessage/index.js",
1896     "groupTitle": "ChatInternalMessage"
1897   },
1898   {
1899     "type": "delete",
1900     "url": "/api/chat/applications/{id}",
1901     "title": "Deletes a Application",
1902     "examples": [
1903       {
1904         "title": "Example usage:",
1905         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1906         "type": "json"
1907       }
1908     ],
1909     "name": "DeleteApplications",
1910     "group": "Chat_Applications",
1911     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1912     "version": "0.0.0",
1913     "filename": "server/api/chatApplication/index.js",
1914     "groupTitle": "Chat_Applications"
1915   },
1916   {
1917     "type": "get",
1918     "url": "/api/chat/applications/{id}",
1919     "title": "Gets a single Application",
1920     "examples": [
1921       {
1922         "title": "Example usage:",
1923         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1924         "type": "json"
1925       }
1926     ],
1927     "name": "ShowApplications",
1928     "group": "Chat_Applications",
1929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1930     "version": "0.0.0",
1931     "filename": "server/api/chatApplication/index.js",
1932     "groupTitle": "Chat_Applications"
1933   },
1934   {
1935     "type": "put",
1936     "url": "/api/chat/applications/{id}",
1937     "title": "Update an existing Application",
1938     "examples": [
1939       {
1940         "title": "Example usage:",
1941         "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",
1942         "type": "json"
1943       }
1944     ],
1945     "name": "updateApplications",
1946     "group": "Chat_Applications",
1947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1948     "version": "0.0.0",
1949     "filename": "server/api/chatApplication/index.js",
1950     "groupTitle": "Chat_Applications"
1951   },
1952   {
1953     "type": "post",
1954     "url": "/api/chat/groups",
1955     "title": "Creates a new Group",
1956     "examples": [
1957       {
1958         "title": "Example usage:",
1959         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1960         "type": "json"
1961       }
1962     ],
1963     "name": "CreateGroups",
1964     "group": "Chat_Groups",
1965     "parameter": {
1966       "fields": {
1967         "Body": [
1968           {
1969             "group": "Body",
1970             "type": "String",
1971             "optional": false,
1972             "field": "name",
1973             "description": ""
1974           },
1975           {
1976             "group": "Body",
1977             "type": "String",
1978             "optional": true,
1979             "field": "description",
1980             "description": ""
1981           },
1982           {
1983             "group": "Body",
1984             "type": "Boolean",
1985             "optional": true,
1986             "field": "write",
1987             "description": ""
1988           }
1989         ]
1990       }
1991     },
1992     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1993     "version": "0.0.0",
1994     "filename": "server/api/chatGroup/index.js",
1995     "groupTitle": "Chat_Groups"
1996   },
1997   {
1998     "type": "delete",
1999     "url": "/api/chat/groups/{id}",
2000     "title": "Deletes a Group",
2001     "examples": [
2002       {
2003         "title": "Example usage:",
2004         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
2005         "type": "json"
2006       }
2007     ],
2008     "name": "DeleteGroups",
2009     "group": "Chat_Groups",
2010     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2011     "version": "0.0.0",
2012     "filename": "server/api/chatGroup/index.js",
2013     "groupTitle": "Chat_Groups"
2014   },
2015   {
2016     "type": "get",
2017     "url": "/api/chat/groups/describe",
2018     "title": "Gets table info about Groups",
2019     "examples": [
2020       {
2021         "title": "Example usage:",
2022         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
2023         "type": "json"
2024       }
2025     ],
2026     "name": "DescribeGroups",
2027     "group": "Chat_Groups",
2028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2029     "version": "0.0.0",
2030     "filename": "server/api/chatGroup/index.js",
2031     "groupTitle": "Chat_Groups"
2032   },
2033   {
2034     "type": "get",
2035     "url": "/api/chat/groups",
2036     "title": "Gets a list of Groups",
2037     "examples": [
2038       {
2039         "title": "Example usage:",
2040         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
2041         "type": "json"
2042       }
2043     ],
2044     "name": "GetGroups",
2045     "group": "Chat_Groups",
2046     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2047     "version": "0.0.0",
2048     "filename": "server/api/chatGroup/index.js",
2049     "groupTitle": "Chat_Groups"
2050   },
2051   {
2052     "type": "delete",
2053     "url": "/api/chat/groups/{id}/members",
2054     "title": "Removes members from a group",
2055     "examples": [
2056       {
2057         "title": "Example usage:",
2058         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2059         "type": "json"
2060       }
2061     ],
2062     "name": "RemoveMembers",
2063     "group": "Chat_Groups",
2064     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2065     "version": "0.0.0",
2066     "filename": "server/api/chatGroup/index.js",
2067     "groupTitle": "Chat_Groups"
2068   },
2069   {
2070     "type": "get",
2071     "url": "/api/chat/groups/{id}",
2072     "title": "Gets a single Group",
2073     "examples": [
2074       {
2075         "title": "Example usage:",
2076         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2077         "type": "json"
2078       }
2079     ],
2080     "name": "ShowGroups",
2081     "group": "Chat_Groups",
2082     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2083     "version": "0.0.0",
2084     "filename": "server/api/chatGroup/index.js",
2085     "groupTitle": "Chat_Groups"
2086   },
2087   {
2088     "type": "post",
2089     "url": "/api/chat/groups/{id}/members",
2090     "title": "Add members to chat group",
2091     "examples": [
2092       {
2093         "title": "Example usage:",
2094         "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",
2095         "type": "json"
2096       }
2097     ],
2098     "name": "addMembers",
2099     "group": "Chat_Groups",
2100     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2101     "version": "0.0.0",
2102     "filename": "server/api/chatGroup/index.js",
2103     "groupTitle": "Chat_Groups"
2104   },
2105   {
2106     "type": "post",
2107     "url": "/api/chat/groups/{id}/messages",
2108     "title": "Creates a new group message",
2109     "examples": [
2110       {
2111         "title": "Example usage:",
2112         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2113         "type": "json"
2114       }
2115     ],
2116     "name": "addMessage",
2117     "group": "Chat_Groups",
2118     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2119     "version": "0.0.0",
2120     "filename": "server/api/chatGroup/index.js",
2121     "groupTitle": "Chat_Groups"
2122   },
2123   {
2124     "type": "get",
2125     "url": "/api/chat/groups/{id}/members",
2126     "title": "Gets Members",
2127     "examples": [
2128       {
2129         "title": "Example usage:",
2130         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2131         "type": "json"
2132       }
2133     ],
2134     "name": "getMembers",
2135     "group": "Chat_Groups",
2136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2137     "version": "0.0.0",
2138     "filename": "server/api/chatGroup/index.js",
2139     "groupTitle": "Chat_Groups"
2140   },
2141   {
2142     "type": "get",
2143     "url": "/api/chat/groups/{id}/messages",
2144     "title": "Gets Messages",
2145     "examples": [
2146       {
2147         "title": "Example usage:",
2148         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2149         "type": "json"
2150       }
2151     ],
2152     "name": "getMessages",
2153     "group": "Chat_Groups",
2154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2155     "version": "0.0.0",
2156     "filename": "server/api/chatGroup/index.js",
2157     "groupTitle": "Chat_Groups"
2158   },
2159   {
2160     "type": "get",
2161     "url": "/api/chat/groups/{id}/unread",
2162     "title": "Get unread chat group messages",
2163     "examples": [
2164       {
2165         "title": "Example usage:",
2166         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2167         "type": "json"
2168       }
2169     ],
2170     "name": "getUread",
2171     "group": "Chat_Groups",
2172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2173     "version": "0.0.0",
2174     "filename": "server/api/chatGroup/index.js",
2175     "groupTitle": "Chat_Groups"
2176   },
2177   {
2178     "type": "put",
2179     "url": "/api/chat/groups/{id}",
2180     "title": "Update an existing Group",
2181     "examples": [
2182       {
2183         "title": "Example usage:",
2184         "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",
2185         "type": "json"
2186       }
2187     ],
2188     "name": "updateGroups",
2189     "group": "Chat_Groups",
2190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2191     "version": "0.0.0",
2192     "filename": "server/api/chatGroup/index.js",
2193     "groupTitle": "Chat_Groups"
2194   },
2195   {
2196     "type": "post",
2197     "url": "/api/chat/interactions/{id}/tags",
2198     "title": "Add tags to the interaction",
2199     "examples": [
2200       {
2201         "title": "Example usage:",
2202         "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",
2203         "type": "json"
2204       }
2205     ],
2206     "name": "AddTags",
2207     "group": "Chat_Interactions",
2208     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2209     "version": "0.0.0",
2210     "filename": "server/api/chatInteraction/index.js",
2211     "groupTitle": "Chat_Interactions"
2212   },
2213   {
2214     "type": "post",
2215     "url": "/api/chat/interactions",
2216     "title": "Creates a new Interaction",
2217     "examples": [
2218       {
2219         "title": "Example usage:",
2220         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2221         "type": "json"
2222       }
2223     ],
2224     "name": "CreateInteractions",
2225     "group": "Chat_Interactions",
2226     "parameter": {
2227       "fields": {
2228         "Body": [
2229           {
2230             "group": "Body",
2231             "type": "Boolean",
2232             "optional": true,
2233             "field": "closed",
2234             "description": ""
2235           },
2236           {
2237             "group": "Body",
2238             "type": "Integer",
2239             "optional": true,
2240             "field": "ratingValue",
2241             "description": ""
2242           },
2243           {
2244             "group": "Body",
2245             "type": "String",
2246             "allowedValues": [
2247               "\"star\"",
2248               "\"thumb\""
2249             ],
2250             "optional": true,
2251             "field": "ratingType",
2252             "description": ""
2253           },
2254           {
2255             "group": "Body",
2256             "type": "Text",
2257             "optional": true,
2258             "field": "ratingMessage",
2259             "description": ""
2260           },
2261           {
2262             "group": "Body",
2263             "type": "Text",
2264             "optional": true,
2265             "field": "pathTranscript",
2266             "description": ""
2267           },
2268           {
2269             "group": "Body",
2270             "type": "String",
2271             "optional": true,
2272             "field": "mailTranscript",
2273             "description": ""
2274           },
2275           {
2276             "group": "Body",
2277             "type": "String",
2278             "optional": true,
2279             "field": "closedAt",
2280             "description": ""
2281           },
2282           {
2283             "group": "Body",
2284             "type": "String",
2285             "optional": true,
2286             "field": "disposition",
2287             "description": ""
2288           },
2289           {
2290             "group": "Body",
2291             "type": "String",
2292             "optional": true,
2293             "field": "secondDisposition",
2294             "description": ""
2295           },
2296           {
2297             "group": "Body",
2298             "type": "String",
2299             "optional": true,
2300             "field": "thirdDisposition",
2301             "description": ""
2302           },
2303           {
2304             "group": "Body",
2305             "type": "String",
2306             "optional": true,
2307             "field": "note",
2308             "description": ""
2309           },
2310           {
2311             "group": "Body",
2312             "type": "String",
2313             "optional": true,
2314             "field": "browserName",
2315             "description": ""
2316           },
2317           {
2318             "group": "Body",
2319             "type": "String",
2320             "optional": true,
2321             "field": "browserVersion",
2322             "description": ""
2323           },
2324           {
2325             "group": "Body",
2326             "type": "String",
2327             "optional": true,
2328             "field": "osName",
2329             "description": ""
2330           },
2331           {
2332             "group": "Body",
2333             "type": "String",
2334             "optional": true,
2335             "field": "osVersion",
2336             "description": ""
2337           },
2338           {
2339             "group": "Body",
2340             "type": "String",
2341             "optional": true,
2342             "field": "deviceModel",
2343             "description": ""
2344           },
2345           {
2346             "group": "Body",
2347             "type": "String",
2348             "optional": true,
2349             "field": "deviceVendor",
2350             "description": ""
2351           },
2352           {
2353             "group": "Body",
2354             "type": "String",
2355             "optional": true,
2356             "field": "deviceType",
2357             "description": ""
2358           },
2359           {
2360             "group": "Body",
2361             "type": "Text",
2362             "optional": true,
2363             "field": "referer",
2364             "description": ""
2365           },
2366           {
2367             "group": "Body",
2368             "type": "String",
2369             "optional": true,
2370             "field": "customerIp",
2371             "description": ""
2372           },
2373           {
2374             "group": "Body",
2375             "type": "Text",
2376             "optional": true,
2377             "field": "formData",
2378             "description": ""
2379           },
2380           {
2381             "group": "Body",
2382             "type": "String",
2383             "optional": true,
2384             "field": "read1stAt",
2385             "description": ""
2386           },
2387           {
2388             "group": "Body",
2389             "type": "String",
2390             "optional": true,
2391             "field": "lastMsgAt",
2392             "description": ""
2393           },
2394           {
2395             "group": "Body",
2396             "type": "String",
2397             "allowedValues": [
2398               "\"in\"",
2399               "\"out\""
2400             ],
2401             "optional": false,
2402             "field": "lastMsgDirection",
2403             "description": ""
2404           },
2405           {
2406             "group": "Body",
2407             "type": "String",
2408             "optional": true,
2409             "field": "closeReason",
2410             "description": ""
2411           },
2412           {
2413             "group": "Body",
2414             "type": "String",
2415             "optional": true,
2416             "field": "customerPort",
2417             "description": ""
2418           },
2419           {
2420             "group": "Body",
2421             "type": "Text",
2422             "optional": true,
2423             "field": "vidaooSessionId",
2424             "description": ""
2425           },
2426           {
2427             "group": "Body",
2428             "type": "Boolean",
2429             "optional": true,
2430             "field": "autoreplyExecuted",
2431             "description": ""
2432           }
2433         ]
2434       }
2435     },
2436     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2437     "version": "0.0.0",
2438     "filename": "server/api/chatInteraction/index.js",
2439     "groupTitle": "Chat_Interactions"
2440   },
2441   {
2442     "type": "delete",
2443     "url": "/api/chat/interactions/{id}",
2444     "title": "Deletes a Interaction",
2445     "examples": [
2446       {
2447         "title": "Example usage:",
2448         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2449         "type": "json"
2450       }
2451     ],
2452     "name": "DeleteInteractions",
2453     "group": "Chat_Interactions",
2454     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2455     "version": "0.0.0",
2456     "filename": "server/api/chatInteraction/index.js",
2457     "groupTitle": "Chat_Interactions"
2458   },
2459   {
2460     "type": "get",
2461     "url": "/api/chat/interactions/describe",
2462     "title": "Gets table info about Interactions",
2463     "examples": [
2464       {
2465         "title": "Example usage:",
2466         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2467         "type": "json"
2468       }
2469     ],
2470     "name": "DescribeInteractions",
2471     "group": "Chat_Interactions",
2472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2473     "version": "0.0.0",
2474     "filename": "server/api/chatInteraction/index.js",
2475     "groupTitle": "Chat_Interactions"
2476   },
2477   {
2478     "type": "get",
2479     "url": "/api/chat/interactions",
2480     "title": "Gets a list of Interactions",
2481     "examples": [
2482       {
2483         "title": "Example usage:",
2484         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2485         "type": "json"
2486       }
2487     ],
2488     "name": "GetInteractions",
2489     "group": "Chat_Interactions",
2490     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2491     "version": "0.0.0",
2492     "filename": "server/api/chatInteraction/index.js",
2493     "groupTitle": "Chat_Interactions"
2494   },
2495   {
2496     "type": "delete",
2497     "url": "/api/chat/interactions/{id}/tags",
2498     "title": "Removes tags from interaction",
2499     "examples": [
2500       {
2501         "title": "Example usage:",
2502         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2503         "type": "json"
2504       }
2505     ],
2506     "name": "RemoveTags",
2507     "group": "Chat_Interactions",
2508     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2509     "version": "0.0.0",
2510     "filename": "server/api/chatInteraction/index.js",
2511     "groupTitle": "Chat_Interactions"
2512   },
2513   {
2514     "type": "get",
2515     "url": "/api/chat/interactions/{id}",
2516     "title": "Gets a single Interaction",
2517     "examples": [
2518       {
2519         "title": "Example usage:",
2520         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2521         "type": "json"
2522       }
2523     ],
2524     "name": "ShowInteractions",
2525     "group": "Chat_Interactions",
2526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "put",
2533     "url": "/api/chat/interactions/{id}/abandon",
2534     "title": "Abandon interaction",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "abandon",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "put",
2551     "url": "/api/chat/interactions/{id}/close",
2552     "title": "Close Interaction",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "addMessage",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "post",
2569     "url": "/api/chat/interactions/{id}/messages",
2570     "title": "Creates new messages",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "addMessage",
2579     "group": "Chat_Interactions",
2580     "parameter": {
2581       "fields": {
2582         "Body": [
2583           {
2584             "group": "Body",
2585             "type": "Text",
2586             "optional": false,
2587             "field": "body",
2588             "description": ""
2589           },
2590           {
2591             "group": "Body",
2592             "type": "Boolean",
2593             "optional": true,
2594             "field": "read",
2595             "description": ""
2596           },
2597           {
2598             "group": "Body",
2599             "type": "Boolean",
2600             "optional": true,
2601             "field": "secret",
2602             "description": ""
2603           },
2604           {
2605             "group": "Body",
2606             "type": "String",
2607             "allowedValues": [
2608               "\"in\"",
2609               "\"out\""
2610             ],
2611             "optional": false,
2612             "field": "direction",
2613             "description": ""
2614           },
2615           {
2616             "group": "Body",
2617             "type": "String",
2618             "optional": true,
2619             "field": "readAt",
2620             "description": ""
2621           },
2622           {
2623             "group": "Body",
2624             "type": "String",
2625             "optional": true,
2626             "field": "providerName",
2627             "description": ""
2628           },
2629           {
2630             "group": "Body",
2631             "type": "Text",
2632             "optional": true,
2633             "field": "providerResponse",
2634             "description": ""
2635           }
2636         ]
2637       }
2638     },
2639     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2640     "version": "0.0.0",
2641     "filename": "server/api/chatInteraction/index.js",
2642     "groupTitle": "Chat_Interactions"
2643   },
2644   {
2645     "type": "post",
2646     "url": "/api/chat/interactions/{id}/attachment_upload",
2647     "title": "Add attachment",
2648     "examples": [
2649       {
2650         "title": "Example usage:",
2651         "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",
2652         "type": "json"
2653       }
2654     ],
2655     "name": "attachmentUpload",
2656     "group": "Chat_Interactions",
2657     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2658     "version": "0.0.0",
2659     "filename": "server/api/chatInteraction/index.js",
2660     "groupTitle": "Chat_Interactions"
2661   },
2662   {
2663     "type": "post",
2664     "url": "/api/chat/interactions/{id}/vidaoo",
2665     "title": "Create Vidaoo Session",
2666     "examples": [
2667       {
2668         "title": "Example usage:",
2669         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2670         "type": "json"
2671       }
2672     ],
2673     "name": "createVidaooSession",
2674     "group": "Chat_Interactions",
2675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2676     "version": "0.0.0",
2677     "filename": "server/api/chatInteraction/index.js",
2678     "groupTitle": "Chat_Interactions"
2679   },
2680   {
2681     "type": "put",
2682     "url": "/api/chat/interactions/{id}/custom_update",
2683     "title": "Update interaction",
2684     "examples": [
2685       {
2686         "title": "Example usage:",
2687         "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",
2688         "type": "json"
2689       }
2690     ],
2691     "name": "customUpdate",
2692     "group": "Chat_Interactions",
2693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2694     "version": "0.0.0",
2695     "filename": "server/api/chatInteraction/index.js",
2696     "groupTitle": "Chat_Interactions"
2697   },
2698   {
2699     "type": "get",
2700     "url": "/api/chat/interactions/{id}/download",
2701     "title": "Gets interaction",
2702     "examples": [
2703       {
2704         "title": "Example usage:",
2705         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2706         "type": "json"
2707       }
2708     ],
2709     "name": "download",
2710     "group": "Chat_Interactions",
2711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2712     "version": "0.0.0",
2713     "filename": "server/api/chatInteraction/index.js",
2714     "groupTitle": "Chat_Interactions"
2715   },
2716   {
2717     "type": "get",
2718     "url": "/api/chat/interactions/{id}/messages",
2719     "title": "Gets interaction messages",
2720     "examples": [
2721       {
2722         "title": "Example usage:",
2723         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2724         "type": "json"
2725       }
2726     ],
2727     "name": "getMessages",
2728     "group": "Chat_Interactions",
2729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2730     "version": "0.0.0",
2731     "filename": "server/api/chatInteraction/index.js",
2732     "groupTitle": "Chat_Interactions"
2733   },
2734   {
2735     "type": "get",
2736     "url": "/api/chat/interactions/{id}/my_messages",
2737     "title": "Gets interaction messages",
2738     "examples": [
2739       {
2740         "title": "Example usage:",
2741         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2742         "type": "json"
2743       }
2744     ],
2745     "name": "getMyMessages",
2746     "group": "Chat_Interactions",
2747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2748     "version": "0.0.0",
2749     "filename": "server/api/chatInteraction/index.js",
2750     "groupTitle": "Chat_Interactions"
2751   },
2752   {
2753     "type": "put",
2754     "url": "/api/chat/interactions/{id}",
2755     "title": "Update an existing Interaction",
2756     "examples": [
2757       {
2758         "title": "Example usage:",
2759         "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",
2760         "type": "json"
2761       }
2762     ],
2763     "name": "updateInteractions",
2764     "group": "Chat_Interactions",
2765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2766     "version": "0.0.0",
2767     "filename": "server/api/chatInteraction/index.js",
2768     "groupTitle": "Chat_Interactions"
2769   },
2770   {
2771     "type": "post",
2772     "url": "/api/chat/internal/messages",
2773     "title": "Creates a new Message",
2774     "examples": [
2775       {
2776         "title": "Example usage:",
2777         "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",
2778         "type": "json"
2779       }
2780     ],
2781     "name": "CreateMessages",
2782     "group": "Chat_Internal_Messages",
2783     "parameter": {
2784       "fields": {
2785         "Body": [
2786           {
2787             "group": "Body",
2788             "type": "Text",
2789             "optional": false,
2790             "field": "body",
2791             "description": ""
2792           },
2793           {
2794             "group": "Body",
2795             "type": "Boolean",
2796             "optional": true,
2797             "field": "read",
2798             "description": ""
2799           },
2800           {
2801             "group": "Body",
2802             "type": "Integer",
2803             "optional": true,
2804             "field": "ChatInternalMessageId",
2805             "description": ""
2806           }
2807         ]
2808       }
2809     },
2810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2811     "version": "0.0.0",
2812     "filename": "server/api/chatInternalMessage/index.js",
2813     "groupTitle": "Chat_Internal_Messages"
2814   },
2815   {
2816     "type": "delete",
2817     "url": "/api/chat/internal/messages/{id}",
2818     "title": "Deletes a Message",
2819     "examples": [
2820       {
2821         "title": "Example usage:",
2822         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2823         "type": "json"
2824       }
2825     ],
2826     "name": "DeleteMessages",
2827     "group": "Chat_Internal_Messages",
2828     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2829     "version": "0.0.0",
2830     "filename": "server/api/chatInternalMessage/index.js",
2831     "groupTitle": "Chat_Internal_Messages"
2832   },
2833   {
2834     "type": "get",
2835     "url": "/api/chat/internal/messages/describe",
2836     "title": "Gets table info about Messages",
2837     "examples": [
2838       {
2839         "title": "Example usage:",
2840         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2841         "type": "json"
2842       }
2843     ],
2844     "name": "DescribeMessages",
2845     "group": "Chat_Internal_Messages",
2846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2847     "version": "0.0.0",
2848     "filename": "server/api/chatInternalMessage/index.js",
2849     "groupTitle": "Chat_Internal_Messages"
2850   },
2851   {
2852     "type": "get",
2853     "url": "/api/chat/internal/messages",
2854     "title": "Gets a list of Messages",
2855     "examples": [
2856       {
2857         "title": "Example usage:",
2858         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2859         "type": "json"
2860       }
2861     ],
2862     "name": "GetMessages",
2863     "group": "Chat_Internal_Messages",
2864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatInternalMessage/index.js",
2867     "groupTitle": "Chat_Internal_Messages"
2868   },
2869   {
2870     "type": "get",
2871     "url": "/api/chat/internal/messages/{id}",
2872     "title": "Gets a single Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "ShowMessages",
2881     "group": "Chat_Internal_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatInternalMessage/index.js",
2885     "groupTitle": "Chat_Internal_Messages"
2886   },
2887   {
2888     "type": "put",
2889     "url": "/api/chat/internal/messages/{id}",
2890     "title": "Update an existing Message",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "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",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "updateMessages",
2899     "group": "Chat_Internal_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatInternalMessage/index.js",
2903     "groupTitle": "Chat_Internal_Messages"
2904   },
2905   {
2906     "type": "post",
2907     "url": "/api/chat/messages",
2908     "title": "Creates a new Message",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "CreateMessages",
2917     "group": "Chat_Messages",
2918     "parameter": {
2919       "fields": {
2920         "Body": [
2921           {
2922             "group": "Body",
2923             "type": "Text",
2924             "optional": false,
2925             "field": "body",
2926             "description": ""
2927           },
2928           {
2929             "group": "Body",
2930             "type": "Boolean",
2931             "optional": true,
2932             "field": "read",
2933             "description": ""
2934           },
2935           {
2936             "group": "Body",
2937             "type": "Boolean",
2938             "optional": true,
2939             "field": "secret",
2940             "description": ""
2941           },
2942           {
2943             "group": "Body",
2944             "type": "String",
2945             "allowedValues": [
2946               "\"in\"",
2947               "\"out\""
2948             ],
2949             "optional": false,
2950             "field": "direction",
2951             "description": ""
2952           },
2953           {
2954             "group": "Body",
2955             "type": "String",
2956             "optional": true,
2957             "field": "readAt",
2958             "description": ""
2959           },
2960           {
2961             "group": "Body",
2962             "type": "String",
2963             "optional": true,
2964             "field": "providerName",
2965             "description": ""
2966           },
2967           {
2968             "group": "Body",
2969             "type": "Text",
2970             "optional": true,
2971             "field": "providerResponse",
2972             "description": ""
2973           }
2974         ]
2975       }
2976     },
2977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2978     "version": "0.0.0",
2979     "filename": "server/api/chatMessage/index.js",
2980     "groupTitle": "Chat_Messages"
2981   },
2982   {
2983     "type": "delete",
2984     "url": "/api/chat/messages/{id}",
2985     "title": "Deletes a Message",
2986     "examples": [
2987       {
2988         "title": "Example usage:",
2989         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2990         "type": "json"
2991       }
2992     ],
2993     "name": "DeleteMessages",
2994     "group": "Chat_Messages",
2995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2996     "version": "0.0.0",
2997     "filename": "server/api/chatMessage/index.js",
2998     "groupTitle": "Chat_Messages"
2999   },
3000   {
3001     "type": "get",
3002     "url": "/api/chat/messages/describe",
3003     "title": "Gets table info about Messages",
3004     "examples": [
3005       {
3006         "title": "Example usage:",
3007         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
3008         "type": "json"
3009       }
3010     ],
3011     "name": "DescribeMessages",
3012     "group": "Chat_Messages",
3013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3014     "version": "0.0.0",
3015     "filename": "server/api/chatMessage/index.js",
3016     "groupTitle": "Chat_Messages"
3017   },
3018   {
3019     "type": "get",
3020     "url": "/api/chat/messages",
3021     "title": "Gets a list of Messages",
3022     "examples": [
3023       {
3024         "title": "Example usage:",
3025         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
3026         "type": "json"
3027       }
3028     ],
3029     "name": "GetMessages",
3030     "group": "Chat_Messages",
3031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3032     "version": "0.0.0",
3033     "filename": "server/api/chatMessage/index.js",
3034     "groupTitle": "Chat_Messages"
3035   },
3036   {
3037     "type": "get",
3038     "url": "/api/chat/messages/{id}",
3039     "title": "Gets a single Message",
3040     "examples": [
3041       {
3042         "title": "Example usage:",
3043         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
3044         "type": "json"
3045       }
3046     ],
3047     "name": "ShowMessages",
3048     "group": "Chat_Messages",
3049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3050     "version": "0.0.0",
3051     "filename": "server/api/chatMessage/index.js",
3052     "groupTitle": "Chat_Messages"
3053   },
3054   {
3055     "type": "put",
3056     "url": "/api/chat/messages/{id}",
3057     "title": "Update an existing Message",
3058     "examples": [
3059       {
3060         "title": "Example usage:",
3061         "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",
3062         "type": "json"
3063       }
3064     ],
3065     "name": "updateMessages",
3066     "group": "Chat_Messages",
3067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3068     "version": "0.0.0",
3069     "filename": "server/api/chatMessage/index.js",
3070     "groupTitle": "Chat_Messages"
3071   },
3072   {
3073     "type": "post",
3074     "url": "/api/chat/offline_messages",
3075     "title": "Creates a new OfflineMessage",
3076     "examples": [
3077       {
3078         "title": "Example usage:",
3079         "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",
3080         "type": "json"
3081       }
3082     ],
3083     "name": "CreateOfflineMessages",
3084     "group": "Chat_Offline_Messages",
3085     "parameter": {
3086       "fields": {
3087         "Body": [
3088           {
3089             "group": "Body",
3090             "type": "Text",
3091             "optional": false,
3092             "field": "body",
3093             "description": ""
3094           }
3095         ]
3096       }
3097     },
3098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3099     "version": "0.0.0",
3100     "filename": "server/api/chatOfflineMessage/index.js",
3101     "groupTitle": "Chat_Offline_Messages"
3102   },
3103   {
3104     "type": "delete",
3105     "url": "/api/chat/offline_messages/{id}",
3106     "title": "Deletes a OfflineMessage",
3107     "examples": [
3108       {
3109         "title": "Example usage:",
3110         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3111         "type": "json"
3112       }
3113     ],
3114     "name": "DeleteOfflineMessages",
3115     "group": "Chat_Offline_Messages",
3116     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3117     "version": "0.0.0",
3118     "filename": "server/api/chatOfflineMessage/index.js",
3119     "groupTitle": "Chat_Offline_Messages"
3120   },
3121   {
3122     "type": "get",
3123     "url": "/api/chat/offline_messages/describe",
3124     "title": "Gets table info about OfflineMessages",
3125     "examples": [
3126       {
3127         "title": "Example usage:",
3128         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3129         "type": "json"
3130       }
3131     ],
3132     "name": "DescribeOfflineMessages",
3133     "group": "Chat_Offline_Messages",
3134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3135     "version": "0.0.0",
3136     "filename": "server/api/chatOfflineMessage/index.js",
3137     "groupTitle": "Chat_Offline_Messages"
3138   },
3139   {
3140     "type": "get",
3141     "url": "/api/chat/offline_messages",
3142     "title": "Gets a list of OfflineMessages",
3143     "examples": [
3144       {
3145         "title": "Example usage:",
3146         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3147         "type": "json"
3148       }
3149     ],
3150     "name": "GetOfflineMessages",
3151     "group": "Chat_Offline_Messages",
3152     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3153     "version": "0.0.0",
3154     "filename": "server/api/chatOfflineMessage/index.js",
3155     "groupTitle": "Chat_Offline_Messages"
3156   },
3157   {
3158     "type": "get",
3159     "url": "/api/chat/offline_messages/{id}",
3160     "title": "Gets a single OfflineMessage",
3161     "examples": [
3162       {
3163         "title": "Example usage:",
3164         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3165         "type": "json"
3166       }
3167     ],
3168     "name": "ShowOfflineMessages",
3169     "group": "Chat_Offline_Messages",
3170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3171     "version": "0.0.0",
3172     "filename": "server/api/chatOfflineMessage/index.js",
3173     "groupTitle": "Chat_Offline_Messages"
3174   },
3175   {
3176     "type": "put",
3177     "url": "/api/chat/offline_messages/{id}",
3178     "title": "Update an existing OfflineMessage",
3179     "examples": [
3180       {
3181         "title": "Example usage:",
3182         "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",
3183         "type": "json"
3184       }
3185     ],
3186     "name": "updateOfflineMessages",
3187     "group": "Chat_Offline_Messages",
3188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3189     "version": "0.0.0",
3190     "filename": "server/api/chatOfflineMessage/index.js",
3191     "groupTitle": "Chat_Offline_Messages"
3192   },
3193   {
3194     "type": "post",
3195     "url": "/api/chat/proactive_actions",
3196     "title": "Creates a new Proactive Action",
3197     "examples": [
3198       {
3199         "title": "Example usage:",
3200         "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",
3201         "type": "json"
3202       }
3203     ],
3204     "name": "CreateProactive_Actions",
3205     "group": "Chat_Proactive_Actions",
3206     "parameter": {
3207       "fields": {
3208         "Body": [
3209           {
3210             "group": "Body",
3211             "type": "String",
3212             "optional": false,
3213             "field": "name",
3214             "description": ""
3215           },
3216           {
3217             "group": "Body",
3218             "type": "String",
3219             "allowedValues": [
3220               "\"mouseOver\"",
3221               "\"timeout\""
3222             ],
3223             "optional": true,
3224             "field": "type",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "selector",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "Integer",
3237             "optional": true,
3238             "field": "timeout",
3239             "description": ""
3240           }
3241         ]
3242       }
3243     },
3244     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3245     "version": "0.0.0",
3246     "filename": "server/api/chatProactiveAction/index.js",
3247     "groupTitle": "Chat_Proactive_Actions"
3248   },
3249   {
3250     "type": "delete",
3251     "url": "/api/chat/proactive_actions/{id}",
3252     "title": "Deletes a Proactive Action",
3253     "examples": [
3254       {
3255         "title": "Example usage:",
3256         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3257         "type": "json"
3258       }
3259     ],
3260     "name": "DeleteProactive_Actions",
3261     "group": "Chat_Proactive_Actions",
3262     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3263     "version": "0.0.0",
3264     "filename": "server/api/chatProactiveAction/index.js",
3265     "groupTitle": "Chat_Proactive_Actions"
3266   },
3267   {
3268     "type": "get",
3269     "url": "/api/chat/proactive_actions/{id}",
3270     "title": "Gets a single Proactive Action",
3271     "examples": [
3272       {
3273         "title": "Example usage:",
3274         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3275         "type": "json"
3276       }
3277     ],
3278     "name": "ShowProactive_Actions",
3279     "group": "Chat_Proactive_Actions",
3280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3281     "version": "0.0.0",
3282     "filename": "server/api/chatProactiveAction/index.js",
3283     "groupTitle": "Chat_Proactive_Actions"
3284   },
3285   {
3286     "type": "put",
3287     "url": "/api/chat/proactive_actions/{id}",
3288     "title": "Update an existing Proactive Action",
3289     "examples": [
3290       {
3291         "title": "Example usage:",
3292         "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",
3293         "type": "json"
3294       }
3295     ],
3296     "name": "updateProactive_Actions",
3297     "group": "Chat_Proactive_Actions",
3298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3299     "version": "0.0.0",
3300     "filename": "server/api/chatProactiveAction/index.js",
3301     "groupTitle": "Chat_Proactive_Actions"
3302   },
3303   {
3304     "type": "post",
3305     "url": "/api/chat/reports/queue",
3306     "title": "Creates a new Chat Queue Report",
3307     "examples": [
3308       {
3309         "title": "Example usage:",
3310         "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",
3311         "type": "json"
3312       }
3313     ],
3314     "name": "CreateChat_Queue_Reports",
3315     "group": "Chat_Queue_Reports",
3316     "parameter": {
3317       "fields": {
3318         "Body": [
3319           {
3320             "group": "Body",
3321             "type": "String",
3322             "optional": false,
3323             "field": "uniqueid",
3324             "description": ""
3325           },
3326           {
3327             "group": "Body",
3328             "type": "String",
3329             "optional": true,
3330             "field": "from",
3331             "description": ""
3332           },
3333           {
3334             "group": "Body",
3335             "type": "String",
3336             "optional": true,
3337             "field": "joinAt",
3338             "description": ""
3339           },
3340           {
3341             "group": "Body",
3342             "type": "String",
3343             "optional": true,
3344             "field": "leaveAt",
3345             "description": ""
3346           },
3347           {
3348             "group": "Body",
3349             "type": "String",
3350             "optional": true,
3351             "field": "acceptAt",
3352             "description": ""
3353           },
3354           {
3355             "group": "Body",
3356             "type": "String",
3357             "optional": true,
3358             "field": "exitAt",
3359             "description": ""
3360           },
3361           {
3362             "group": "Body",
3363             "type": "String",
3364             "optional": true,
3365             "field": "reason",
3366             "description": ""
3367           }
3368         ]
3369       }
3370     },
3371     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3372     "version": "0.0.0",
3373     "filename": "server/api/chatQueueReport/index.js",
3374     "groupTitle": "Chat_Queue_Reports"
3375   },
3376   {
3377     "type": "delete",
3378     "url": "/api/chat/reports/queue/{id}",
3379     "title": "Deletes a Chat Queue Report",
3380     "examples": [
3381       {
3382         "title": "Example usage:",
3383         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3384         "type": "json"
3385       }
3386     ],
3387     "name": "DeleteChat_Queue_Reports",
3388     "group": "Chat_Queue_Reports",
3389     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3390     "version": "0.0.0",
3391     "filename": "server/api/chatQueueReport/index.js",
3392     "groupTitle": "Chat_Queue_Reports"
3393   },
3394   {
3395     "type": "get",
3396     "url": "/api/chat/reports/queue/describe",
3397     "title": "Gets table info about Chat Queue Reports",
3398     "examples": [
3399       {
3400         "title": "Example usage:",
3401         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3402         "type": "json"
3403       }
3404     ],
3405     "name": "DescribeChat_Queue_Reports",
3406     "group": "Chat_Queue_Reports",
3407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3408     "version": "0.0.0",
3409     "filename": "server/api/chatQueueReport/index.js",
3410     "groupTitle": "Chat_Queue_Reports"
3411   },
3412   {
3413     "type": "get",
3414     "url": "/api/chat/reports/queue",
3415     "title": "Gets a list of Chat Queue Reports",
3416     "examples": [
3417       {
3418         "title": "Example usage:",
3419         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3420         "type": "json"
3421       }
3422     ],
3423     "name": "GetChat_Queue_Reports",
3424     "group": "Chat_Queue_Reports",
3425     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3426     "version": "0.0.0",
3427     "filename": "server/api/chatQueueReport/index.js",
3428     "groupTitle": "Chat_Queue_Reports"
3429   },
3430   {
3431     "type": "get",
3432     "url": "/api/chat/reports/queue/{id}",
3433     "title": "Gets a single Chat Queue Report",
3434     "examples": [
3435       {
3436         "title": "Example usage:",
3437         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3438         "type": "json"
3439       }
3440     ],
3441     "name": "ShowChat_Queue_Reports",
3442     "group": "Chat_Queue_Reports",
3443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3444     "version": "0.0.0",
3445     "filename": "server/api/chatQueueReport/index.js",
3446     "groupTitle": "Chat_Queue_Reports"
3447   },
3448   {
3449     "type": "put",
3450     "url": "/api/chat/reports/queue/{id}",
3451     "title": "Update an existing Chat Queue Report",
3452     "examples": [
3453       {
3454         "title": "Example usage:",
3455         "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",
3456         "type": "json"
3457       }
3458     ],
3459     "name": "updateChat_Queue_Reports",
3460     "group": "Chat_Queue_Reports",
3461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3462     "version": "0.0.0",
3463     "filename": "server/api/chatQueueReport/index.js",
3464     "groupTitle": "Chat_Queue_Reports"
3465   },
3466   {
3467     "type": "post",
3468     "url": "/api/chat/queues/{id}/users",
3469     "title": "Add agents to a queue",
3470     "examples": [
3471       {
3472         "title": "Example usage:",
3473         "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",
3474         "type": "json"
3475       }
3476     ],
3477     "name": "AddAgents",
3478     "group": "Chat_Queues",
3479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3480     "version": "0.0.0",
3481     "filename": "server/api/chatQueue/index.js",
3482     "groupTitle": "Chat_Queues"
3483   },
3484   {
3485     "type": "post",
3486     "url": "/api/chat/queues/{id}/teams",
3487     "title": "Add teams to a queue",
3488     "examples": [
3489       {
3490         "title": "Example usage:",
3491         "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",
3492         "type": "json"
3493       }
3494     ],
3495     "name": "AddTeams",
3496     "group": "Chat_Queues",
3497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3498     "version": "0.0.0",
3499     "filename": "server/api/chatQueue/index.js",
3500     "groupTitle": "Chat_Queues"
3501   },
3502   {
3503     "type": "post",
3504     "url": "/api/chat/queues",
3505     "title": "Creates a new Queue",
3506     "examples": [
3507       {
3508         "title": "Example usage:",
3509         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3510         "type": "json"
3511       }
3512     ],
3513     "name": "CreateQueues",
3514     "group": "Chat_Queues",
3515     "parameter": {
3516       "fields": {
3517         "Body": [
3518           {
3519             "group": "Body",
3520             "type": "String",
3521             "optional": false,
3522             "field": "name",
3523             "description": ""
3524           },
3525           {
3526             "group": "Body",
3527             "type": "String",
3528             "optional": true,
3529             "field": "description",
3530             "description": ""
3531           },
3532           {
3533             "group": "Body",
3534             "type": "Integer",
3535             "optional": true,
3536             "field": "timeout",
3537             "description": ""
3538           },
3539           {
3540             "group": "Body",
3541             "type": "String",
3542             "allowedValues": [
3543               "\"rrmemory\"",
3544               "\"beepall\"",
3545               "\"roundrobin\""
3546             ],
3547             "optional": true,
3548             "field": "strategy",
3549             "description": ""
3550           }
3551         ]
3552       }
3553     },
3554     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3555     "version": "0.0.0",
3556     "filename": "server/api/chatQueue/index.js",
3557     "groupTitle": "Chat_Queues"
3558   },
3559   {
3560     "type": "delete",
3561     "url": "/api/chat/queues/{id}",
3562     "title": "Deletes a Queue",
3563     "examples": [
3564       {
3565         "title": "Example usage:",
3566         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3567         "type": "json"
3568       }
3569     ],
3570     "name": "DeleteQueues",
3571     "group": "Chat_Queues",
3572     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3573     "version": "0.0.0",
3574     "filename": "server/api/chatQueue/index.js",
3575     "groupTitle": "Chat_Queues"
3576   },
3577   {
3578     "type": "get",
3579     "url": "/api/chat/queues/describe",
3580     "title": "Gets table info about Queues",
3581     "examples": [
3582       {
3583         "title": "Example usage:",
3584         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3585         "type": "json"
3586       }
3587     ],
3588     "name": "DescribeQueues",
3589     "group": "Chat_Queues",
3590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3591     "version": "0.0.0",
3592     "filename": "server/api/chatQueue/index.js",
3593     "groupTitle": "Chat_Queues"
3594   },
3595   {
3596     "type": "get",
3597     "url": "/api/chat/queues/{id}/users",
3598     "title": "Gets queue agents",
3599     "examples": [
3600       {
3601         "title": "Example usage:",
3602         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3603         "type": "json"
3604       }
3605     ],
3606     "name": "GetAgents",
3607     "group": "Chat_Queues",
3608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3609     "version": "0.0.0",
3610     "filename": "server/api/chatQueue/index.js",
3611     "groupTitle": "Chat_Queues"
3612   },
3613   {
3614     "type": "get",
3615     "url": "/api/chat/queues/{id}/members",
3616     "title": "GetMembers",
3617     "examples": [
3618       {
3619         "title": "Example usage:",
3620         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3621         "type": "json"
3622       }
3623     ],
3624     "name": "GetMembers",
3625     "group": "Chat_Queues",
3626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3627     "version": "0.0.0",
3628     "filename": "server/api/chatQueue/index.js",
3629     "groupTitle": "Chat_Queues"
3630   },
3631   {
3632     "type": "get",
3633     "url": "/api/chat/queues",
3634     "title": "Gets a list of Queues",
3635     "examples": [
3636       {
3637         "title": "Example usage:",
3638         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3639         "type": "json"
3640       }
3641     ],
3642     "name": "GetQueues",
3643     "group": "Chat_Queues",
3644     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3645     "version": "0.0.0",
3646     "filename": "server/api/chatQueue/index.js",
3647     "groupTitle": "Chat_Queues"
3648   },
3649   {
3650     "type": "get",
3651     "url": "/api/chat/queues/{id}/teams",
3652     "title": "Gets queues list",
3653     "examples": [
3654       {
3655         "title": "Example usage:",
3656         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3657         "type": "json"
3658       }
3659     ],
3660     "name": "GetTeams",
3661     "group": "Chat_Queues",
3662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3663     "version": "0.0.0",
3664     "filename": "server/api/chatQueue/index.js",
3665     "groupTitle": "Chat_Queues"
3666   },
3667   {
3668     "type": "delete",
3669     "url": "/api/chat/queues/{id}/users",
3670     "title": "Removes agents from a queue",
3671     "examples": [
3672       {
3673         "title": "Example usage:",
3674         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3675         "type": "json"
3676       }
3677     ],
3678     "name": "RemoveAgents",
3679     "group": "Chat_Queues",
3680     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3681     "version": "0.0.0",
3682     "filename": "server/api/chatQueue/index.js",
3683     "groupTitle": "Chat_Queues"
3684   },
3685   {
3686     "type": "get",
3687     "url": "/api/chat/queues/{id}",
3688     "title": "Gets a single Queue",
3689     "examples": [
3690       {
3691         "title": "Example usage:",
3692         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3693         "type": "json"
3694       }
3695     ],
3696     "name": "ShowQueues",
3697     "group": "Chat_Queues",
3698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3699     "version": "0.0.0",
3700     "filename": "server/api/chatQueue/index.js",
3701     "groupTitle": "Chat_Queues"
3702   },
3703   {
3704     "type": "put",
3705     "url": "/api/chat/queues/{id}",
3706     "title": "Update an existing Queue",
3707     "examples": [
3708       {
3709         "title": "Example usage:",
3710         "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",
3711         "type": "json"
3712       }
3713     ],
3714     "name": "updateQueues",
3715     "group": "Chat_Queues",
3716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3717     "version": "0.0.0",
3718     "filename": "server/api/chatQueue/index.js",
3719     "groupTitle": "Chat_Queues"
3720   },
3721   {
3722     "type": "post",
3723     "url": "/api/chat/reports/transfer",
3724     "title": "Creates a new Chat Transfer Report",
3725     "examples": [
3726       {
3727         "title": "Example usage:",
3728         "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",
3729         "type": "json"
3730       }
3731     ],
3732     "name": "CreateChat_Transfer_Reports",
3733     "group": "Chat_Transfer_Reports",
3734     "parameter": {
3735       "fields": {
3736         "Body": [
3737           {
3738             "group": "Body",
3739             "type": "String",
3740             "optional": false,
3741             "field": "uniqueid",
3742             "description": ""
3743           },
3744           {
3745             "group": "Body",
3746             "type": "String",
3747             "allowedValues": [
3748               "\"account\"",
3749               "\"agent\"",
3750               "\"queue\""
3751             ],
3752             "optional": false,
3753             "field": "type",
3754             "description": ""
3755           },
3756           {
3757             "group": "Body",
3758             "type": "String",
3759             "optional": false,
3760             "field": "transferredAt",
3761             "description": ""
3762           }
3763         ]
3764       }
3765     },
3766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3767     "version": "0.0.0",
3768     "filename": "server/api/chatTransferReport/index.js",
3769     "groupTitle": "Chat_Transfer_Reports"
3770   },
3771   {
3772     "type": "delete",
3773     "url": "/api/chat/reports/transfer/{id}",
3774     "title": "Deletes a Chat Transfer Report",
3775     "examples": [
3776       {
3777         "title": "Example usage:",
3778         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3779         "type": "json"
3780       }
3781     ],
3782     "name": "DeleteChat_Transfer_Reports",
3783     "group": "Chat_Transfer_Reports",
3784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3785     "version": "0.0.0",
3786     "filename": "server/api/chatTransferReport/index.js",
3787     "groupTitle": "Chat_Transfer_Reports"
3788   },
3789   {
3790     "type": "get",
3791     "url": "/api/chat/reports/transfer/describe",
3792     "title": "Gets table info about Chat Transfer Reports",
3793     "examples": [
3794       {
3795         "title": "Example usage:",
3796         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3797         "type": "json"
3798       }
3799     ],
3800     "name": "DescribeChat_Transfer_Reports",
3801     "group": "Chat_Transfer_Reports",
3802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3803     "version": "0.0.0",
3804     "filename": "server/api/chatTransferReport/index.js",
3805     "groupTitle": "Chat_Transfer_Reports"
3806   },
3807   {
3808     "type": "get",
3809     "url": "/api/chat/reports/transfer",
3810     "title": "Gets a list of Chat Transfer Reports",
3811     "examples": [
3812       {
3813         "title": "Example usage:",
3814         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3815         "type": "json"
3816       }
3817     ],
3818     "name": "GetChat_Transfer_Reports",
3819     "group": "Chat_Transfer_Reports",
3820     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3821     "version": "0.0.0",
3822     "filename": "server/api/chatTransferReport/index.js",
3823     "groupTitle": "Chat_Transfer_Reports"
3824   },
3825   {
3826     "type": "get",
3827     "url": "/api/chat/reports/transfer/{id}",
3828     "title": "Gets a single Chat Transfer Report",
3829     "examples": [
3830       {
3831         "title": "Example usage:",
3832         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3833         "type": "json"
3834       }
3835     ],
3836     "name": "ShowChat_Transfer_Reports",
3837     "group": "Chat_Transfer_Reports",
3838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3839     "version": "0.0.0",
3840     "filename": "server/api/chatTransferReport/index.js",
3841     "groupTitle": "Chat_Transfer_Reports"
3842   },
3843   {
3844     "type": "put",
3845     "url": "/api/chat/reports/transfer/{id}",
3846     "title": "Update an existing Chat Transfer Report",
3847     "examples": [
3848       {
3849         "title": "Example usage:",
3850         "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",
3851         "type": "json"
3852       }
3853     ],
3854     "name": "updateChat_Transfer_Reports",
3855     "group": "Chat_Transfer_Reports",
3856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3857     "version": "0.0.0",
3858     "filename": "server/api/chatTransferReport/index.js",
3859     "groupTitle": "Chat_Transfer_Reports"
3860   },
3861   {
3862     "type": "post",
3863     "url": "/api/chat/websites/{id}/users",
3864     "title": "Add agents to a website",
3865     "examples": [
3866       {
3867         "title": "Example usage:",
3868         "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",
3869         "type": "json"
3870       }
3871     ],
3872     "name": "AddAgents",
3873     "group": "Chat_Websites",
3874     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3875     "version": "0.0.0",
3876     "filename": "server/api/chatWebsite/index.js",
3877     "groupTitle": "Chat_Websites"
3878   },
3879   {
3880     "type": "post",
3881     "url": "/api/chat/websites",
3882     "title": "Creates a new Website",
3883     "examples": [
3884       {
3885         "title": "Example usage:",
3886         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3887         "type": "json"
3888       }
3889     ],
3890     "name": "CreateWebsites",
3891     "group": "Chat_Websites",
3892     "parameter": {
3893       "fields": {
3894         "Body": [
3895           {
3896             "group": "Body",
3897             "type": "String",
3898             "optional": false,
3899             "field": "name",
3900             "description": ""
3901           },
3902           {
3903             "group": "Body",
3904             "type": "String",
3905             "optional": false,
3906             "field": "address",
3907             "description": ""
3908           },
3909           {
3910             "group": "Body",
3911             "type": "String",
3912             "optional": true,
3913             "field": "description",
3914             "description": ""
3915           },
3916           {
3917             "group": "Body",
3918             "type": "String",
3919             "optional": true,
3920             "field": "mapKey",
3921             "description": ""
3922           },
3923           {
3924             "group": "Body",
3925             "type": "String",
3926             "optional": true,
3927             "field": "mapKeyOffline",
3928             "description": ""
3929           },
3930           {
3931             "group": "Body",
3932             "type": "String",
3933             "optional": false,
3934             "field": "key",
3935             "description": ""
3936           },
3937           {
3938             "group": "Body",
3939             "type": "String",
3940             "optional": true,
3941             "field": "agentAlias",
3942             "description": ""
3943           },
3944           {
3945             "group": "Body",
3946             "type": "String",
3947             "optional": true,
3948             "field": "customerAlias",
3949             "description": ""
3950           },
3951           {
3952             "group": "Body",
3953             "type": "String",
3954             "optional": false,
3955             "field": "color",
3956             "description": ""
3957           },
3958           {
3959             "group": "Body",
3960             "type": "String",
3961             "optional": false,
3962             "field": "color_button",
3963             "description": ""
3964           },
3965           {
3966             "group": "Body",
3967             "type": "String",
3968             "optional": false,
3969             "field": "textColor",
3970             "description": ""
3971           },
3972           {
3973             "group": "Body",
3974             "type": "Integer",
3975             "optional": true,
3976             "field": "fontSize",
3977             "description": ""
3978           },
3979           {
3980             "group": "Body",
3981             "type": "String",
3982             "optional": true,
3983             "field": "remote",
3984             "description": ""
3985           },
3986           {
3987             "group": "Body",
3988             "type": "Boolean",
3989             "optional": true,
3990             "field": "animation",
3991             "description": ""
3992           },
3993           {
3994             "group": "Body",
3995             "type": "String",
3996             "allowedValues": [
3997               "\"rounded\"",
3998               "\"squared\""
3999             ],
4000             "optional": true,
4001             "field": "header_shape",
4002             "description": ""
4003           },
4004           {
4005             "group": "Body",
4006             "type": "String",
4007             "optional": true,
4008             "field": "header_online",
4009             "description": ""
4010           },
4011           {
4012             "group": "Body",
4013             "type": "String",
4014             "optional": true,
4015             "field": "start_chat_button",
4016             "description": ""
4017           },
4018           {
4019             "group": "Body",
4020             "type": "String",
4021             "optional": true,
4022             "field": "offline_chat_button",
4023             "description": ""
4024           },
4025           {
4026             "group": "Body",
4027             "type": "String",
4028             "optional": true,
4029             "field": "header_offline",
4030             "description": ""
4031           },
4032           {
4033             "group": "Body",
4034             "type": "Boolean",
4035             "optional": true,
4036             "field": "download_transcript",
4037             "description": ""
4038           },
4039           {
4040             "group": "Body",
4041             "type": "Integer",
4042             "optional": true,
4043             "field": "timeout",
4044             "description": ""
4045           },
4046           {
4047             "group": "Body",
4048             "type": "String",
4049             "optional": true,
4050             "field": "whiteLabel",
4051             "description": ""
4052           },
4053           {
4054             "group": "Body",
4055             "type": "Boolean",
4056             "optional": true,
4057             "field": "defaultWhiteLabel",
4058             "description": ""
4059           },
4060           {
4061             "group": "Body",
4062             "type": "Text",
4063             "optional": true,
4064             "field": "sitepic",
4065             "description": ""
4066           },
4067           {
4068             "group": "Body",
4069             "type": "String",
4070             "optional": true,
4071             "field": "closingQuestion",
4072             "description": ""
4073           },
4074           {
4075             "group": "Body",
4076             "type": "String",
4077             "optional": true,
4078             "field": "formSubmitSuccessMessage",
4079             "description": ""
4080           },
4081           {
4082             "group": "Body",
4083             "type": "String",
4084             "optional": true,
4085             "field": "formSubmitFailureMessage",
4086             "description": ""
4087           },
4088           {
4089             "group": "Body",
4090             "type": "String",
4091             "optional": true,
4092             "field": "noteTitle",
4093             "description": ""
4094           },
4095           {
4096             "group": "Body",
4097             "type": "String",
4098             "optional": true,
4099             "field": "placeholderMessage",
4100             "description": ""
4101           },
4102           {
4103             "group": "Body",
4104             "type": "String",
4105             "optional": true,
4106             "field": "closingMessage",
4107             "description": ""
4108           },
4109           {
4110             "group": "Body",
4111             "type": "String",
4112             "optional": true,
4113             "field": "closingMessageButton",
4114             "description": ""
4115           },
4116           {
4117             "group": "Body",
4118             "type": "String",
4119             "optional": true,
4120             "field": "skipMessageButton",
4121             "description": ""
4122           },
4123           {
4124             "group": "Body",
4125             "type": "Boolean",
4126             "optional": true,
4127             "field": "conditionAgreement",
4128             "description": ""
4129           },
4130           {
4131             "group": "Body",
4132             "type": "Boolean",
4133             "optional": true,
4134             "field": "enableRating",
4135             "description": ""
4136           },
4137           {
4138             "group": "Body",
4139             "type": "Boolean",
4140             "optional": true,
4141             "field": "enableFeedback",
4142             "description": ""
4143           },
4144           {
4145             "group": "Body",
4146             "type": "Boolean",
4147             "optional": true,
4148             "field": "enableSendButton",
4149             "description": ""
4150           },
4151           {
4152             "group": "Body",
4153             "type": "String",
4154             "optional": true,
4155             "field": "feedbackTitle",
4156             "description": ""
4157           },
4158           {
4159             "group": "Body",
4160             "type": "String",
4161             "allowedValues": [
4162               "\"star\"",
4163               "\"thumb\""
4164             ],
4165             "optional": true,
4166             "field": "ratingType",
4167             "description": ""
4168           },
4169           {
4170             "group": "Body",
4171             "type": "Integer",
4172             "optional": true,
4173             "field": "ratingStarsNumber",
4174             "description": ""
4175           },
4176           {
4177             "group": "Body",
4178             "type": "Text",
4179             "optional": true,
4180             "field": "onlineForm",
4181             "description": ""
4182           },
4183           {
4184             "group": "Body",
4185             "type": "Text",
4186             "optional": true,
4187             "field": "offlineForm",
4188             "description": ""
4189           },
4190           {
4191             "group": "Body",
4192             "type": "String",
4193             "optional": true,
4194             "field": "token",
4195             "description": ""
4196           },
4197           {
4198             "group": "Body",
4199             "type": "Boolean",
4200             "optional": true,
4201             "field": "autoclose",
4202             "description": ""
4203           },
4204           {
4205             "group": "Body",
4206             "type": "Boolean",
4207             "optional": true,
4208             "field": "enableCustomerWriting",
4209             "description": ""
4210           },
4211           {
4212             "group": "Body",
4213             "type": "Boolean",
4214             "optional": true,
4215             "field": "forwardTranscript",
4216             "description": ""
4217           },
4218           {
4219             "group": "Body",
4220             "type": "String",
4221             "optional": true,
4222             "field": "forwardTranscriptMessage",
4223             "description": ""
4224           },
4225           {
4226             "group": "Body",
4227             "type": "Boolean",
4228             "optional": true,
4229             "field": "forwardOffline",
4230             "description": ""
4231           },
4232           {
4233             "group": "Body",
4234             "type": "String",
4235             "optional": true,
4236             "field": "forwardOfflineAddress",
4237             "description": ""
4238           },
4239           {
4240             "group": "Body",
4241             "type": "String",
4242             "optional": true,
4243             "field": "waitingTitle",
4244             "description": ""
4245           },
4246           {
4247             "group": "Body",
4248             "type": "String",
4249             "optional": true,
4250             "field": "waitingMessage",
4251             "description": ""
4252           },
4253           {
4254             "group": "Body",
4255             "type": "String",
4256             "optional": true,
4257             "field": "offlineMessageSubject",
4258             "description": ""
4259           },
4260           {
4261             "group": "Body",
4262             "type": "String",
4263             "optional": true,
4264             "field": "offlineMessageBody",
4265             "description": ""
4266           },
4267           {
4268             "group": "Body",
4269             "type": "Boolean",
4270             "optional": true,
4271             "field": "enableUnmanagedNote",
4272             "description": ""
4273           },
4274           {
4275             "group": "Body",
4276             "type": "String",
4277             "optional": true,
4278             "field": "unmanagedMessage",
4279             "description": ""
4280           },
4281           {
4282             "group": "Body",
4283             "type": "String",
4284             "optional": true,
4285             "field": "skipUnmanaged",
4286             "description": ""
4287           },
4288           {
4289             "group": "Body",
4290             "type": "String",
4291             "optional": true,
4292             "field": "sendUnmanaged",
4293             "description": ""
4294           },
4295           {
4296             "group": "Body",
4297             "type": "Boolean",
4298             "optional": true,
4299             "field": "enableCustomerAttachment",
4300             "description": ""
4301           },
4302           {
4303             "group": "Body",
4304             "type": "Boolean",
4305             "optional": true,
4306             "field": "enableCustomerCheckmarks",
4307             "description": ""
4308           },
4309           {
4310             "group": "Body",
4311             "type": "Text",
4312             "optional": true,
4313             "field": "agentAvatar",
4314             "description": ""
4315           },
4316           {
4317             "group": "Body",
4318             "type": "Boolean",
4319             "optional": true,
4320             "field": "showAgentAvatar",
4321             "description": ""
4322           },
4323           {
4324             "group": "Body",
4325             "type": "String",
4326             "optional": true,
4327             "field": "timezone",
4328             "description": ""
4329           },
4330           {
4331             "group": "Body",
4332             "type": "Text",
4333             "optional": true,
4334             "field": "notificationTemplate",
4335             "description": ""
4336           },
4337           {
4338             "group": "Body",
4339             "type": "Boolean",
4340             "optional": true,
4341             "field": "notificationSound",
4342             "description": ""
4343           },
4344           {
4345             "group": "Body",
4346             "type": "Boolean",
4347             "optional": true,
4348             "field": "notificationShake",
4349             "description": ""
4350           },
4351           {
4352             "group": "Body",
4353             "type": "Boolean",
4354             "optional": true,
4355             "field": "hideWhenOffline",
4356             "description": ""
4357           },
4358           {
4359             "group": "Body",
4360             "type": "String",
4361             "optional": true,
4362             "field": "agentIdentifier",
4363             "description": ""
4364           },
4365           {
4366             "group": "Body",
4367             "type": "Integer",
4368             "optional": true,
4369             "field": "waitForTheAssignedAgent",
4370             "description": ""
4371           },
4372           {
4373             "group": "Body",
4374             "type": "Integer",
4375             "optional": true,
4376             "field": "waitForTheAssignedQueue",
4377             "description": ""
4378           },
4379           {
4380             "group": "Body",
4381             "type": "String",
4382             "optional": true,
4383             "field": "alignment",
4384             "description": ""
4385           },
4386           {
4387             "group": "Body",
4388             "type": "Integer",
4389             "optional": true,
4390             "field": "verticalAlignment",
4391             "description": ""
4392           },
4393           {
4394             "group": "Body",
4395             "type": "String",
4396             "optional": true,
4397             "field": "labelText",
4398             "description": ""
4399           },
4400           {
4401             "group": "Body",
4402             "type": "String",
4403             "optional": true,
4404             "field": "messagesAlignment",
4405             "description": ""
4406           },
4407           {
4408             "group": "Body",
4409             "type": "String",
4410             "optional": true,
4411             "field": "defaultTitle",
4412             "description": ""
4413           },
4414           {
4415             "group": "Body",
4416             "type": "Text",
4417             "optional": true,
4418             "field": "customerAvatar",
4419             "description": ""
4420           },
4421           {
4422             "group": "Body",
4423             "type": "Boolean",
4424             "optional": true,
4425             "field": "showCustomerAvatar",
4426             "description": ""
4427           },
4428           {
4429             "group": "Body",
4430             "type": "Integer",
4431             "optional": true,
4432             "field": "messageFontSize",
4433             "description": ""
4434           },
4435           {
4436             "group": "Body",
4437             "type": "String",
4438             "optional": false,
4439             "field": "backgroundColor",
4440             "description": ""
4441           },
4442           {
4443             "group": "Body",
4444             "type": "Boolean",
4445             "optional": true,
4446             "field": "queueTransfer",
4447             "description": ""
4448           },
4449           {
4450             "group": "Body",
4451             "type": "Integer",
4452             "optional": true,
4453             "field": "queueTransferTimeout",
4454             "description": ""
4455           },
4456           {
4457             "group": "Body",
4458             "type": "Boolean",
4459             "optional": true,
4460             "field": "agentTransfer",
4461             "description": ""
4462           },
4463           {
4464             "group": "Body",
4465             "type": "Integer",
4466             "optional": true,
4467             "field": "agentTransferTimeout",
4468             "description": ""
4469           },
4470           {
4471             "group": "Body",
4472             "type": "String",
4473             "optional": true,
4474             "field": "systemAlias",
4475             "description": ""
4476           },
4477           {
4478             "group": "Body",
4479             "type": "Text",
4480             "optional": true,
4481             "field": "systemAvatar",
4482             "description": ""
4483           },
4484           {
4485             "group": "Body",
4486             "type": "Integer",
4487             "optional": true,
4488             "field": "mandatoryDispositionPauseId",
4489             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4490           },
4491           {
4492             "group": "Body",
4493             "type": "Boolean",
4494             "optional": true,
4495             "field": "mandatoryDisposition",
4496             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4497           },
4498           {
4499             "group": "Body",
4500             "type": "Boolean",
4501             "optional": true,
4502             "field": "vidaooEscalation",
4503             "description": ""
4504           },
4505           {
4506             "group": "Body",
4507             "type": "String",
4508             "optional": true,
4509             "field": "vidaooApiKey",
4510             "description": ""
4511           },
4512           {
4513             "group": "Body",
4514             "type": "String",
4515             "optional": false,
4516             "field": "vidaooTopic",
4517             "description": ""
4518           },
4519           {
4520             "group": "Body",
4521             "type": "String",
4522             "optional": true,
4523             "field": "vidaooNote",
4524             "description": ""
4525           },
4526           {
4527             "group": "Body",
4528             "type": "Text",
4529             "optional": true,
4530             "field": "vidaooMetadata",
4531             "description": ""
4532           },
4533           {
4534             "group": "Body",
4535             "type": "Boolean",
4536             "optional": true,
4537             "field": "openNewInteraction",
4538             "description": ""
4539           },
4540           {
4541             "group": "Body",
4542             "type": "Text",
4543             "optional": true,
4544             "field": "subjectOffline",
4545             "description": ""
4546           }
4547         ]
4548       }
4549     },
4550     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4551     "version": "0.0.0",
4552     "filename": "server/api/chatWebsite/index.js",
4553     "groupTitle": "Chat_Websites"
4554   },
4555   {
4556     "type": "delete",
4557     "url": "/api/chat/websites/{id}",
4558     "title": "Deletes a Website",
4559     "examples": [
4560       {
4561         "title": "Example usage:",
4562         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4563         "type": "json"
4564       }
4565     ],
4566     "name": "DeleteWebsites",
4567     "group": "Chat_Websites",
4568     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4569     "version": "0.0.0",
4570     "filename": "server/api/chatWebsite/index.js",
4571     "groupTitle": "Chat_Websites"
4572   },
4573   {
4574     "type": "get",
4575     "url": "/api/chat/websites/describe",
4576     "title": "Gets table info about Websites",
4577     "examples": [
4578       {
4579         "title": "Example usage:",
4580         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4581         "type": "json"
4582       }
4583     ],
4584     "name": "DescribeWebsites",
4585     "group": "Chat_Websites",
4586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4587     "version": "0.0.0",
4588     "filename": "server/api/chatWebsite/index.js",
4589     "groupTitle": "Chat_Websites"
4590   },
4591   {
4592     "type": "get",
4593     "url": "/api/chat/websites/{id}/users",
4594     "title": "Gets agents from website",
4595     "examples": [
4596       {
4597         "title": "Example usage:",
4598         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4599         "type": "json"
4600       }
4601     ],
4602     "name": "GetAgents",
4603     "group": "Chat_Websites",
4604     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4605     "version": "0.0.0",
4606     "filename": "server/api/chatWebsite/index.js",
4607     "groupTitle": "Chat_Websites"
4608   },
4609   {
4610     "type": "get",
4611     "url": "/api/chat/websites",
4612     "title": "Gets a list of Websites",
4613     "examples": [
4614       {
4615         "title": "Example usage:",
4616         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4617         "type": "json"
4618       }
4619     ],
4620     "name": "GetWebsites",
4621     "group": "Chat_Websites",
4622     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4623     "version": "0.0.0",
4624     "filename": "server/api/chatWebsite/index.js",
4625     "groupTitle": "Chat_Websites"
4626   },
4627   {
4628     "type": "delete",
4629     "url": "/api/chat/websites/{id}/users",
4630     "title": "Removes agents from a website",
4631     "examples": [
4632       {
4633         "title": "Example usage:",
4634         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4635         "type": "json"
4636       }
4637     ],
4638     "name": "RemoveAgents",
4639     "group": "Chat_Websites",
4640     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4641     "version": "0.0.0",
4642     "filename": "server/api/chatWebsite/index.js",
4643     "groupTitle": "Chat_Websites"
4644   },
4645   {
4646     "type": "delete",
4647     "url": "/api/chat/websites/{id}/canned_answers",
4648     "title": "Removes canned answers from account",
4649     "examples": [
4650       {
4651         "title": "Example usage:",
4652         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4653         "type": "json"
4654       }
4655     ],
4656     "name": "RemoveAnswers",
4657     "group": "Chat_Websites",
4658     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4659     "version": "0.0.0",
4660     "filename": "server/api/chatWebsite/index.js",
4661     "groupTitle": "Chat_Websites"
4662   },
4663   {
4664     "type": "delete",
4665     "url": "/api/chat/websites/{id}/dispositions",
4666     "title": "Removes canned answers from account",
4667     "examples": [
4668       {
4669         "title": "Example usage:",
4670         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4671         "type": "json"
4672       }
4673     ],
4674     "name": "RemoveDispositions",
4675     "group": "Chat_Websites",
4676     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4677     "version": "0.0.0",
4678     "filename": "server/api/chatWebsite/index.js",
4679     "groupTitle": "Chat_Websites"
4680   },
4681   {
4682     "type": "get",
4683     "url": "/api/chat/websites/{id}",
4684     "title": "Gets a single Website",
4685     "examples": [
4686       {
4687         "title": "Example usage:",
4688         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4689         "type": "json"
4690       }
4691     ],
4692     "name": "ShowWebsites",
4693     "group": "Chat_Websites",
4694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4695     "version": "0.0.0",
4696     "filename": "server/api/chatWebsite/index.js",
4697     "groupTitle": "Chat_Websites"
4698   },
4699   {
4700     "type": "put",
4701     "url": "/api/chat/messages/{id}/accept",
4702     "title": "Accepts message",
4703     "examples": [
4704       {
4705         "title": "Example usage:",
4706         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4707         "type": "json"
4708       }
4709     ],
4710     "name": "acceptMessage",
4711     "group": "Chat_Websites",
4712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4713     "version": "0.0.0",
4714     "filename": "server/api/chatMessage/index.js",
4715     "groupTitle": "Chat_Websites"
4716   },
4717   {
4718     "type": "post",
4719     "url": "/api/chat/websites/{id}/canned_answers",
4720     "title": "Creates new canned answer",
4721     "examples": [
4722       {
4723         "title": "Example usage:",
4724         "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",
4725         "type": "json"
4726       }
4727     ],
4728     "name": "addAnswer",
4729     "group": "Chat_Websites",
4730     "parameter": {
4731       "fields": {
4732         "Body": [
4733           {
4734             "group": "Body",
4735             "type": "String",
4736             "optional": false,
4737             "field": "key",
4738             "description": ""
4739           },
4740           {
4741             "group": "Body",
4742             "type": "Text",
4743             "optional": false,
4744             "field": "value",
4745             "description": ""
4746           },
4747           {
4748             "group": "Body",
4749             "type": "String",
4750             "optional": true,
4751             "field": "description",
4752             "description": ""
4753           },
4754           {
4755             "group": "Body",
4756             "type": "Virtual",
4757             "optional": true,
4758             "field": "name",
4759             "description": ""
4760           }
4761         ]
4762       }
4763     },
4764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4765     "version": "0.0.0",
4766     "filename": "server/api/chatWebsite/index.js",
4767     "groupTitle": "Chat_Websites"
4768   },
4769   {
4770     "type": "post",
4771     "url": "/api/chat/websites/{id}/applications",
4772     "title": "Creates new applications",
4773     "examples": [
4774       {
4775         "title": "Example usage:",
4776         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4777         "type": "json"
4778       }
4779     ],
4780     "name": "addApplications",
4781     "group": "Chat_Websites",
4782     "parameter": {
4783       "fields": {
4784         "Body": [
4785           {
4786             "group": "Body",
4787             "type": "Integer",
4788             "optional": false,
4789             "field": "priority",
4790             "description": ""
4791           },
4792           {
4793             "group": "Body",
4794             "type": "String",
4795             "optional": false,
4796             "field": "app",
4797             "description": ""
4798           },
4799           {
4800             "group": "Body",
4801             "type": "Text",
4802             "optional": true,
4803             "field": "appdata",
4804             "description": ""
4805           },
4806           {
4807             "group": "Body",
4808             "type": "String",
4809             "optional": true,
4810             "field": "description",
4811             "description": ""
4812           },
4813           {
4814             "group": "Body",
4815             "type": "String",
4816             "optional": true,
4817             "field": "interval",
4818             "description": ""
4819           }
4820         ]
4821       }
4822     },
4823     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4824     "version": "0.0.0",
4825     "filename": "server/api/chatWebsite/index.js",
4826     "groupTitle": "Chat_Websites"
4827   },
4828   {
4829     "type": "post",
4830     "url": "/api/chat/websites/{id}/avatar",
4831     "title": "Add avatar",
4832     "examples": [
4833       {
4834         "title": "Example usage:",
4835         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4836         "type": "json"
4837       }
4838     ],
4839     "name": "addAvatar",
4840     "group": "Chat_Websites",
4841     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4842     "version": "0.0.0",
4843     "filename": "server/api/chatWebsite/index.js",
4844     "groupTitle": "Chat_Websites"
4845   },
4846   {
4847     "type": "post",
4848     "url": "/api/chat/websites/{id}/customer_avatar",
4849     "title": "Add customer avatar",
4850     "examples": [
4851       {
4852         "title": "Example usage:",
4853         "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",
4854         "type": "json"
4855       }
4856     ],
4857     "name": "addCustomerAvatar",
4858     "group": "Chat_Websites",
4859     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4860     "version": "0.0.0",
4861     "filename": "server/api/chatWebsite/index.js",
4862     "groupTitle": "Chat_Websites"
4863   },
4864   {
4865     "type": "post",
4866     "url": "/api/chat/websites/{id}/dispositions",
4867     "title": "Creates new disposition",
4868     "examples": [
4869       {
4870         "title": "Example usage:",
4871         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4872         "type": "json"
4873       }
4874     ],
4875     "name": "addDisposition",
4876     "group": "Chat_Websites",
4877     "parameter": {
4878       "fields": {
4879         "Body": [
4880           {
4881             "group": "Body",
4882             "type": "String",
4883             "optional": false,
4884             "field": "name",
4885             "description": ""
4886           },
4887           {
4888             "group": "Body",
4889             "type": "String",
4890             "allowedValues": [
4891               "\"first\"",
4892               "\"second\"",
4893               "\"third\""
4894             ],
4895             "optional": false,
4896             "field": "level",
4897             "description": ""
4898           },
4899           {
4900             "group": "Body",
4901             "type": "String",
4902             "optional": true,
4903             "field": "description",
4904             "description": ""
4905           }
4906         ]
4907       }
4908     },
4909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4910     "version": "0.0.0",
4911     "filename": "server/api/chatWebsite/index.js",
4912     "groupTitle": "Chat_Websites"
4913   },
4914   {
4915     "type": "post",
4916     "url": "/api/chat/accounts/{id}/interactions",
4917     "title": "Creates new interactions",
4918     "examples": [
4919       {
4920         "title": "Example usage:",
4921         "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",
4922         "type": "json"
4923       }
4924     ],
4925     "name": "addInteraction",
4926     "group": "Chat_Websites",
4927     "parameter": {
4928       "fields": {
4929         "Body": [
4930           {
4931             "group": "Body",
4932             "type": "Boolean",
4933             "optional": true,
4934             "field": "closed",
4935             "description": ""
4936           },
4937           {
4938             "group": "Body",
4939             "type": "Integer",
4940             "optional": true,
4941             "field": "ratingValue",
4942             "description": ""
4943           },
4944           {
4945             "group": "Body",
4946             "type": "String",
4947             "allowedValues": [
4948               "\"star\"",
4949               "\"thumb\""
4950             ],
4951             "optional": true,
4952             "field": "ratingType",
4953             "description": ""
4954           },
4955           {
4956             "group": "Body",
4957             "type": "Text",
4958             "optional": true,
4959             "field": "ratingMessage",
4960             "description": ""
4961           },
4962           {
4963             "group": "Body",
4964             "type": "Text",
4965             "optional": true,
4966             "field": "pathTranscript",
4967             "description": ""
4968           },
4969           {
4970             "group": "Body",
4971             "type": "String",
4972             "optional": true,
4973             "field": "mailTranscript",
4974             "description": ""
4975           },
4976           {
4977             "group": "Body",
4978             "type": "String",
4979             "optional": true,
4980             "field": "closedAt",
4981             "description": ""
4982           },
4983           {
4984             "group": "Body",
4985             "type": "String",
4986             "optional": true,
4987             "field": "disposition",
4988             "description": ""
4989           },
4990           {
4991             "group": "Body",
4992             "type": "String",
4993             "optional": true,
4994             "field": "secondDisposition",
4995             "description": ""
4996           },
4997           {
4998             "group": "Body",
4999             "type": "String",
5000             "optional": true,
5001             "field": "thirdDisposition",
5002             "description": ""
5003           },
5004           {
5005             "group": "Body",
5006             "type": "String",
5007             "optional": true,
5008             "field": "note",
5009             "description": ""
5010           },
5011           {
5012             "group": "Body",
5013             "type": "String",
5014             "optional": true,
5015             "field": "browserName",
5016             "description": ""
5017           },
5018           {
5019             "group": "Body",
5020             "type": "String",
5021             "optional": true,
5022             "field": "browserVersion",
5023             "description": ""
5024           },
5025           {
5026             "group": "Body",
5027             "type": "String",
5028             "optional": true,
5029             "field": "osName",
5030             "description": ""
5031           },
5032           {
5033             "group": "Body",
5034             "type": "String",
5035             "optional": true,
5036             "field": "osVersion",
5037             "description": ""
5038           },
5039           {
5040             "group": "Body",
5041             "type": "String",
5042             "optional": true,
5043             "field": "deviceModel",
5044             "description": ""
5045           },
5046           {
5047             "group": "Body",
5048             "type": "String",
5049             "optional": true,
5050             "field": "deviceVendor",
5051             "description": ""
5052           },
5053           {
5054             "group": "Body",
5055             "type": "String",
5056             "optional": true,
5057             "field": "deviceType",
5058             "description": ""
5059           },
5060           {
5061             "group": "Body",
5062             "type": "Text",
5063             "optional": true,
5064             "field": "referer",
5065             "description": ""
5066           },
5067           {
5068             "group": "Body",
5069             "type": "String",
5070             "optional": true,
5071             "field": "customerIp",
5072             "description": ""
5073           },
5074           {
5075             "group": "Body",
5076             "type": "Text",
5077             "optional": true,
5078             "field": "formData",
5079             "description": ""
5080           },
5081           {
5082             "group": "Body",
5083             "type": "String",
5084             "optional": true,
5085             "field": "read1stAt",
5086             "description": ""
5087           },
5088           {
5089             "group": "Body",
5090             "type": "String",
5091             "optional": true,
5092             "field": "lastMsgAt",
5093             "description": ""
5094           },
5095           {
5096             "group": "Body",
5097             "type": "String",
5098             "allowedValues": [
5099               "\"in\"",
5100               "\"out\""
5101             ],
5102             "optional": false,
5103             "field": "lastMsgDirection",
5104             "description": ""
5105           },
5106           {
5107             "group": "Body",
5108             "type": "String",
5109             "optional": true,
5110             "field": "closeReason",
5111             "description": ""
5112           },
5113           {
5114             "group": "Body",
5115             "type": "String",
5116             "optional": true,
5117             "field": "customerPort",
5118             "description": ""
5119           },
5120           {
5121             "group": "Body",
5122             "type": "Text",
5123             "optional": true,
5124             "field": "vidaooSessionId",
5125             "description": ""
5126           },
5127           {
5128             "group": "Body",
5129             "type": "Boolean",
5130             "optional": true,
5131             "field": "autoreplyExecuted",
5132             "description": ""
5133           }
5134         ]
5135       }
5136     },
5137     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "post",
5144     "url": "/api/chat/websites/{id}/logo",
5145     "title": "Add logo",
5146     "examples": [
5147       {
5148         "title": "Example usage:",
5149         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5150         "type": "json"
5151       }
5152     ],
5153     "name": "addLogo",
5154     "group": "Chat_Websites",
5155     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/proactive_actions",
5163     "title": "Creates new Proactive Actions",
5164     "examples": [
5165       {
5166         "title": "Example usage:",
5167         "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",
5168         "type": "json"
5169       }
5170     ],
5171     "name": "addProactiveActions",
5172     "group": "Chat_Websites",
5173     "parameter": {
5174       "fields": {
5175         "Body": [
5176           {
5177             "group": "Body",
5178             "type": "String",
5179             "optional": false,
5180             "field": "name",
5181             "description": ""
5182           },
5183           {
5184             "group": "Body",
5185             "type": "String",
5186             "allowedValues": [
5187               "\"mouseOver\"",
5188               "\"timeout\""
5189             ],
5190             "optional": true,
5191             "field": "type",
5192             "description": ""
5193           },
5194           {
5195             "group": "Body",
5196             "type": "String",
5197             "optional": true,
5198             "field": "selector",
5199             "description": ""
5200           },
5201           {
5202             "group": "Body",
5203             "type": "Integer",
5204             "optional": true,
5205             "field": "timeout",
5206             "description": ""
5207           }
5208         ]
5209       }
5210     },
5211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5212     "version": "0.0.0",
5213     "filename": "server/api/chatWebsite/index.js",
5214     "groupTitle": "Chat_Websites"
5215   },
5216   {
5217     "type": "post",
5218     "url": "/api/chat/websites/{id}/system_avatar",
5219     "title": "Add system avatar",
5220     "examples": [
5221       {
5222         "title": "Example usage:",
5223         "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",
5224         "type": "json"
5225       }
5226     ],
5227     "name": "addSystemAvatar",
5228     "group": "Chat_Websites",
5229     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5230     "version": "0.0.0",
5231     "filename": "server/api/chatWebsite/index.js",
5232     "groupTitle": "Chat_Websites"
5233   },
5234   {
5235     "type": "get",
5236     "url": "/api/chat/websites/{id}/canned_answers",
5237     "title": "Gets account canned answers",
5238     "examples": [
5239       {
5240         "title": "Example usage:",
5241         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5242         "type": "json"
5243       }
5244     ],
5245     "name": "getAnswers",
5246     "group": "Chat_Websites",
5247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5248     "version": "0.0.0",
5249     "filename": "server/api/chatWebsite/index.js",
5250     "groupTitle": "Chat_Websites"
5251   },
5252   {
5253     "type": "get",
5254     "url": "/api/chat/websites/{id}/applications",
5255     "title": "Gets Website Applications",
5256     "examples": [
5257       {
5258         "title": "Example usage:",
5259         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5260         "type": "json"
5261       }
5262     ],
5263     "name": "getApplications",
5264     "group": "Chat_Websites",
5265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5266     "version": "0.0.0",
5267     "filename": "server/api/chatWebsite/index.js",
5268     "groupTitle": "Chat_Websites"
5269   },
5270   {
5271     "type": "get",
5272     "url": "/api/chat/websites/{id}/avatar",
5273     "title": "Get avatar",
5274     "examples": [
5275       {
5276         "title": "Example usage:",
5277         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5278         "type": "json"
5279       }
5280     ],
5281     "name": "getAvatar",
5282     "group": "Chat_Websites",
5283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5284     "version": "0.0.0",
5285     "filename": "server/api/chatWebsite/index.js",
5286     "groupTitle": "Chat_Websites"
5287   },
5288   {
5289     "type": "get",
5290     "url": "/api/chat/websites/{id}/customer_avatar",
5291     "title": "Get Customer Avatar",
5292     "examples": [
5293       {
5294         "title": "Example usage:",
5295         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5296         "type": "json"
5297       }
5298     ],
5299     "name": "getCustomerAvatar",
5300     "group": "Chat_Websites",
5301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5302     "version": "0.0.0",
5303     "filename": "server/api/chatWebsite/index.js",
5304     "groupTitle": "Chat_Websites"
5305   },
5306   {
5307     "type": "get",
5308     "url": "/api/chat/websites/{id}/dispositions",
5309     "title": "Gets account dispositions",
5310     "examples": [
5311       {
5312         "title": "Example usage:",
5313         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5314         "type": "json"
5315       }
5316     ],
5317     "name": "getDispositions",
5318     "group": "Chat_Websites",
5319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5320     "version": "0.0.0",
5321     "filename": "server/api/chatWebsite/index.js",
5322     "groupTitle": "Chat_Websites"
5323   },
5324   {
5325     "type": "get",
5326     "url": "/api/chat/websites/{id}/fields",
5327     "title": "Gets Website Fields",
5328     "examples": [
5329       {
5330         "title": "Example usage:",
5331         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5332         "type": "json"
5333       }
5334     ],
5335     "name": "getFields",
5336     "group": "Chat_Websites",
5337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5338     "version": "0.0.0",
5339     "filename": "server/api/chatWebsite/index.js",
5340     "groupTitle": "Chat_Websites"
5341   },
5342   {
5343     "type": "get",
5344     "url": "/api/chat/websites/{id}/interactions",
5345     "title": "Gets Website Interactions",
5346     "examples": [
5347       {
5348         "title": "Example usage:",
5349         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5350         "type": "json"
5351       }
5352     ],
5353     "name": "getInteraction",
5354     "group": "Chat_Websites",
5355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5356     "version": "0.0.0",
5357     "filename": "server/api/chatWebsite/index.js",
5358     "groupTitle": "Chat_Websites"
5359   },
5360   {
5361     "type": "get",
5362     "url": "/api/chat/websites/{id}/logo",
5363     "title": "Get logo",
5364     "examples": [
5365       {
5366         "title": "Example usage:",
5367         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5368         "type": "json"
5369       }
5370     ],
5371     "name": "getLogo",
5372     "group": "Chat_Websites",
5373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5374     "version": "0.0.0",
5375     "filename": "server/api/chatWebsite/index.js",
5376     "groupTitle": "Chat_Websites"
5377   },
5378   {
5379     "type": "get",
5380     "url": "/api/chat/websites/{id}/offline_messages",
5381     "title": "Gets Website Offline Messages",
5382     "examples": [
5383       {
5384         "title": "Example usage:",
5385         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5386         "type": "json"
5387       }
5388     ],
5389     "name": "getOfflineMessages",
5390     "group": "Chat_Websites",
5391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5392     "version": "0.0.0",
5393     "filename": "server/api/chatWebsite/index.js",
5394     "groupTitle": "Chat_Websites"
5395   },
5396   {
5397     "type": "get",
5398     "url": "/api/chat/websites/{id}/proactive_actions",
5399     "title": "Gets Website Proactive Actions",
5400     "examples": [
5401       {
5402         "title": "Example usage:",
5403         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5404         "type": "json"
5405       }
5406     ],
5407     "name": "getProactiveActions",
5408     "group": "Chat_Websites",
5409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5410     "version": "0.0.0",
5411     "filename": "server/api/chatWebsite/index.js",
5412     "groupTitle": "Chat_Websites"
5413   },
5414   {
5415     "type": "get",
5416     "url": "/api/chat/websites/{id}/snippet",
5417     "title": "Gets Website Snippet",
5418     "examples": [
5419       {
5420         "title": "Example usage:",
5421         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5422         "type": "json"
5423       }
5424     ],
5425     "name": "getSnippet",
5426     "group": "Chat_Websites",
5427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5428     "version": "0.0.0",
5429     "filename": "server/api/chatWebsite/index.js",
5430     "groupTitle": "Chat_Websites"
5431   },
5432   {
5433     "type": "get",
5434     "url": "/api/chat/websites/{id}/system_avatar",
5435     "title": "Get System Avatar",
5436     "examples": [
5437       {
5438         "title": "Example usage:",
5439         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5440         "type": "json"
5441       }
5442     ],
5443     "name": "getSystemAvatar",
5444     "group": "Chat_Websites",
5445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5446     "version": "0.0.0",
5447     "filename": "server/api/chatWebsite/index.js",
5448     "groupTitle": "Chat_Websites"
5449   },
5450   {
5451     "type": "post",
5452     "url": "/api/chat/websites/{id}/notify",
5453     "title": "Notify new message",
5454     "examples": [
5455       {
5456         "title": "Example usage:",
5457         "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",
5458         "type": "json"
5459       }
5460     ],
5461     "name": "notify",
5462     "group": "Chat_Websites",
5463     "description": "<p>Motion 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>",
5464     "version": "0.0.0",
5465     "filename": "server/api/chatWebsite/index.js",
5466     "groupTitle": "Chat_Websites"
5467   },
5468   {
5469     "type": "post",
5470     "url": "/api/chat/websites/{id}/offline",
5471     "title": "Offline message",
5472     "examples": [
5473       {
5474         "title": "Example usage:",
5475         "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",
5476         "type": "json"
5477       }
5478     ],
5479     "name": "offline",
5480     "group": "Chat_Websites",
5481     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5482     "version": "0.0.0",
5483     "filename": "server/api/chatWebsite/index.js",
5484     "groupTitle": "Chat_Websites"
5485   },
5486   {
5487     "type": "put",
5488     "url": "/api/chat/messages/{id}/reject",
5489     "title": "Rejects message",
5490     "examples": [
5491       {
5492         "title": "Example usage:",
5493         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5494         "type": "json"
5495       }
5496     ],
5497     "name": "rejectMessage",
5498     "group": "Chat_Websites",
5499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5500     "version": "0.0.0",
5501     "filename": "server/api/chatMessage/index.js",
5502     "groupTitle": "Chat_Websites"
5503   },
5504   {
5505     "type": "put",
5506     "url": "/api/chat/websites/{id}",
5507     "title": "Update an existing Website",
5508     "examples": [
5509       {
5510         "title": "Example usage:",
5511         "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",
5512         "type": "json"
5513       }
5514     ],
5515     "name": "updateWebsites",
5516     "group": "Chat_Websites",
5517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5518     "version": "0.0.0",
5519     "filename": "server/api/chatWebsite/index.js",
5520     "groupTitle": "Chat_Websites"
5521   },
5522   {
5523     "type": "post",
5524     "url": "/api/cloudProviders",
5525     "title": "Creates a new CloudProvider",
5526     "examples": [
5527       {
5528         "title": "Example usage:",
5529         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5530         "type": "json"
5531       }
5532     ],
5533     "name": "CreateCloudProviders",
5534     "group": "CloudProviders",
5535     "parameter": {
5536       "fields": {
5537         "Body": [
5538           {
5539             "group": "Body",
5540             "type": "String",
5541             "optional": false,
5542             "field": "name",
5543             "description": ""
5544           },
5545           {
5546             "group": "Body",
5547             "type": "String",
5548             "allowedValues": [
5549               "\"AmazonAWS\"",
5550               "\"Google\""
5551             ],
5552             "optional": false,
5553             "field": "service",
5554             "description": ""
5555           },
5556           {
5557             "group": "Body",
5558             "type": "String",
5559             "optional": true,
5560             "field": "data1",
5561             "description": ""
5562           },
5563           {
5564             "group": "Body",
5565             "type": "String",
5566             "optional": true,
5567             "field": "data2",
5568             "description": ""
5569           }
5570         ]
5571       }
5572     },
5573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5574     "version": "0.0.0",
5575     "filename": "server/api/cloudProvider/index.js",
5576     "groupTitle": "CloudProviders"
5577   },
5578   {
5579     "type": "delete",
5580     "url": "/api/cloudProviders/{id}",
5581     "title": "Deletes a CloudProvider",
5582     "examples": [
5583       {
5584         "title": "Example usage:",
5585         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5586         "type": "json"
5587       }
5588     ],
5589     "name": "DeleteCloudProviders",
5590     "group": "CloudProviders",
5591     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5592     "version": "0.0.0",
5593     "filename": "server/api/cloudProvider/index.js",
5594     "groupTitle": "CloudProviders"
5595   },
5596   {
5597     "type": "get",
5598     "url": "/api/cloudProviders",
5599     "title": "Gets a list of CloudProviders",
5600     "examples": [
5601       {
5602         "title": "Example usage:",
5603         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5604         "type": "json"
5605       }
5606     ],
5607     "name": "GetCloudProviders",
5608     "group": "CloudProviders",
5609     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5610     "version": "0.0.0",
5611     "filename": "server/api/cloudProvider/index.js",
5612     "groupTitle": "CloudProviders"
5613   },
5614   {
5615     "type": "get",
5616     "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5617     "title": "Generates the Microsoft Identity platform authorization url",
5618     "examples": [
5619       {
5620         "title": "Example usage:",
5621         "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5622         "type": "json"
5623       }
5624     ],
5625     "name": "Oauth2MicrosoftAuthorize",
5626     "group": "CloudProviders",
5627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5628     "version": "0.0.0",
5629     "filename": "server/api/cloudProvider/index.js",
5630     "groupTitle": "CloudProviders"
5631   },
5632   {
5633     "type": "post",
5634     "url": "/api/cloudProviders/oauth2/microsoft/callback",
5635     "title": "Receives an authorization code from Microsoft Identity platform",
5636     "name": "Oauth2MicrosoftCallback",
5637     "group": "CloudProviders",
5638     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5639     "version": "0.0.0",
5640     "filename": "server/api/cloudProvider/index.js",
5641     "groupTitle": "CloudProviders"
5642   },
5643   {
5644     "type": "get",
5645     "url": "/api/cloudProviders/{id}",
5646     "title": "Gets a single CloudProvider",
5647     "examples": [
5648       {
5649         "title": "Example usage:",
5650         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5651         "type": "json"
5652       }
5653     ],
5654     "name": "ShowCloudProviders",
5655     "group": "CloudProviders",
5656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5657     "version": "0.0.0",
5658     "filename": "server/api/cloudProvider/index.js",
5659     "groupTitle": "CloudProviders"
5660   },
5661   {
5662     "type": "put",
5663     "url": "/api/cloudProviders/{id}",
5664     "title": "Update an existing CloudProvider",
5665     "examples": [
5666       {
5667         "title": "Example usage:",
5668         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5669         "type": "json"
5670       }
5671     ],
5672     "name": "updateCloudProviders",
5673     "group": "CloudProviders",
5674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5675     "version": "0.0.0",
5676     "filename": "server/api/cloudProvider/index.js",
5677     "groupTitle": "CloudProviders"
5678   },
5679   {
5680     "type": "post",
5681     "url": "/api/cm_contact_has_items",
5682     "title": "Creates a new CmContactHasItem",
5683     "examples": [
5684       {
5685         "title": "Example usage:",
5686         "content": "curl https://{domain}/api/cm_contact_has_items -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5687         "type": "json"
5688       }
5689     ],
5690     "name": "CreateCmContactHasItems",
5691     "group": "CmContactHasItems",
5692     "parameter": {
5693       "fields": {
5694         "Body": [
5695           {
5696             "group": "Body",
5697             "type": "Integer",
5698             "optional": true,
5699             "field": "CmContactId",
5700             "description": ""
5701           },
5702           {
5703             "group": "Body",
5704             "type": "String",
5705             "optional": true,
5706             "field": "item",
5707             "description": ""
5708           },
5709           {
5710             "group": "Body",
5711             "type": "Integer",
5712             "optional": true,
5713             "field": "ItemTypeId",
5714             "description": ""
5715           },
5716           {
5717             "group": "Body",
5718             "type": "String",
5719             "optional": true,
5720             "field": "ItemClass",
5721             "description": ""
5722           },
5723           {
5724             "group": "Body",
5725             "type": "Integer",
5726             "optional": true,
5727             "field": "OrderBy",
5728             "description": ""
5729           },
5730           {
5731             "group": "Body",
5732             "type": "String",
5733             "optional": true,
5734             "field": "description",
5735             "description": ""
5736           }
5737         ]
5738       }
5739     },
5740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5741     "version": "0.0.0",
5742     "filename": "server/api/cmContactHasItem/index.js",
5743     "groupTitle": "CmContactHasItems"
5744   },
5745   {
5746     "type": "delete",
5747     "url": "/api/cm_contact_has_items/{id}",
5748     "title": "Deletes a CmContactHasItem",
5749     "examples": [
5750       {
5751         "title": "Example usage:",
5752         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5753         "type": "json"
5754       }
5755     ],
5756     "name": "DeleteCmContactHasItems",
5757     "group": "CmContactHasItems",
5758     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5759     "version": "0.0.0",
5760     "filename": "server/api/cmContactHasItem/index.js",
5761     "groupTitle": "CmContactHasItems"
5762   },
5763   {
5764     "type": "get",
5765     "url": "/api/cm_contact_has_items",
5766     "title": "Gets a list of CmContactHasItems",
5767     "examples": [
5768       {
5769         "title": "Example usage:",
5770         "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5771         "type": "json"
5772       }
5773     ],
5774     "name": "GetCmContactHasItems",
5775     "group": "CmContactHasItems",
5776     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_contact_has_items?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_contact_has_items?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_contact_has_items?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_contact_has_items?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_contact_has_items?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5777     "version": "0.0.0",
5778     "filename": "server/api/cmContactHasItem/index.js",
5779     "groupTitle": "CmContactHasItems"
5780   },
5781   {
5782     "type": "get",
5783     "url": "/api/cm_contact_has_items/{id}",
5784     "title": "Gets a single CmContactHasItem",
5785     "examples": [
5786       {
5787         "title": "Example usage:",
5788         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5789         "type": "json"
5790       }
5791     ],
5792     "name": "ShowCmContactHasItems",
5793     "group": "CmContactHasItems",
5794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5795     "version": "0.0.0",
5796     "filename": "server/api/cmContactHasItem/index.js",
5797     "groupTitle": "CmContactHasItems"
5798   },
5799   {
5800     "type": "put",
5801     "url": "/api/cm_contact_has_items/{id}",
5802     "title": "Update an existing CmContactHasItem",
5803     "examples": [
5804       {
5805         "title": "Example usage:",
5806         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5807         "type": "json"
5808       }
5809     ],
5810     "name": "updateCmContactHasItems",
5811     "group": "CmContactHasItems",
5812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5813     "version": "0.0.0",
5814     "filename": "server/api/cmContactHasItem/index.js",
5815     "groupTitle": "CmContactHasItems"
5816   },
5817   {
5818     "type": "post",
5819     "url": "/api/cm_hopper_additional_phones",
5820     "title": "Creates a new CmHopperAdditionalPhone",
5821     "examples": [
5822       {
5823         "title": "Example usage:",
5824         "content": "curl https://{domain}/api/cm_hopper_additional_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5825         "type": "json"
5826       }
5827     ],
5828     "name": "CreateCmHopperAdditionalPhones",
5829     "group": "CmHopperAdditionalPhones",
5830     "parameter": {
5831       "fields": {
5832         "Body": [
5833           {
5834             "group": "Body",
5835             "type": "Integer",
5836             "optional": true,
5837             "field": "CmHopperId",
5838             "description": ""
5839           },
5840           {
5841             "group": "Body",
5842             "type": "String",
5843             "optional": false,
5844             "field": "phone",
5845             "description": ""
5846           },
5847           {
5848             "group": "Body",
5849             "type": "Integer",
5850             "optional": true,
5851             "field": "OrderBy",
5852             "description": ""
5853           },
5854           {
5855             "group": "Body",
5856             "type": "String",
5857             "optional": true,
5858             "field": "scheduledat",
5859             "description": ""
5860           },
5861           {
5862             "group": "Body",
5863             "type": "Integer",
5864             "optional": true,
5865             "field": "countbusyretry",
5866             "description": ""
5867           },
5868           {
5869             "group": "Body",
5870             "type": "Integer",
5871             "optional": true,
5872             "field": "countcongestionretry",
5873             "description": ""
5874           },
5875           {
5876             "group": "Body",
5877             "type": "Integer",
5878             "optional": true,
5879             "field": "countnoanswerretry",
5880             "description": ""
5881           },
5882           {
5883             "group": "Body",
5884             "type": "Integer",
5885             "optional": true,
5886             "field": "countnosuchnumberretry",
5887             "description": ""
5888           },
5889           {
5890             "group": "Body",
5891             "type": "Integer",
5892             "optional": true,
5893             "field": "countdropretry",
5894             "description": ""
5895           },
5896           {
5897             "group": "Body",
5898             "type": "Integer",
5899             "optional": true,
5900             "field": "countabandonedretry",
5901             "description": ""
5902           },
5903           {
5904             "group": "Body",
5905             "type": "Integer",
5906             "optional": true,
5907             "field": "countmachineretry",
5908             "description": ""
5909           },
5910           {
5911             "group": "Body",
5912             "type": "Integer",
5913             "optional": true,
5914             "field": "countagentrejectretry",
5915             "description": ""
5916           }
5917         ]
5918       }
5919     },
5920     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5921     "version": "0.0.0",
5922     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5923     "groupTitle": "CmHopperAdditionalPhones"
5924   },
5925   {
5926     "type": "delete",
5927     "url": "/api/cm_hopper_additional_phones/{id}",
5928     "title": "Deletes a CmHopperAdditionalPhone",
5929     "examples": [
5930       {
5931         "title": "Example usage:",
5932         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5933         "type": "json"
5934       }
5935     ],
5936     "name": "DeleteCmHopperAdditionalPhones",
5937     "group": "CmHopperAdditionalPhones",
5938     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5939     "version": "0.0.0",
5940     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5941     "groupTitle": "CmHopperAdditionalPhones"
5942   },
5943   {
5944     "type": "get",
5945     "url": "/api/cm_hopper_additional_phones",
5946     "title": "Gets a list of CmHopperAdditionalPhones",
5947     "examples": [
5948       {
5949         "title": "Example usage:",
5950         "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5951         "type": "json"
5952       }
5953     ],
5954     "name": "GetCmHopperAdditionalPhones",
5955     "group": "CmHopperAdditionalPhones",
5956     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_hopper_additional_phones?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_hopper_additional_phones?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5957     "version": "0.0.0",
5958     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5959     "groupTitle": "CmHopperAdditionalPhones"
5960   },
5961   {
5962     "type": "get",
5963     "url": "/api/cm_hopper_additional_phones/{id}",
5964     "title": "Gets a single CmHopperAdditionalPhone",
5965     "examples": [
5966       {
5967         "title": "Example usage:",
5968         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5969         "type": "json"
5970       }
5971     ],
5972     "name": "ShowCmHopperAdditionalPhones",
5973     "group": "CmHopperAdditionalPhones",
5974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5975     "version": "0.0.0",
5976     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5977     "groupTitle": "CmHopperAdditionalPhones"
5978   },
5979   {
5980     "type": "put",
5981     "url": "/api/cm_hopper_additional_phones/{id}",
5982     "title": "Update an existing CmHopperAdditionalPhone",
5983     "examples": [
5984       {
5985         "title": "Example usage:",
5986         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5987         "type": "json"
5988       }
5989     ],
5990     "name": "updateCmHopperAdditionalPhones",
5991     "group": "CmHopperAdditionalPhones",
5992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5993     "version": "0.0.0",
5994     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5995     "groupTitle": "CmHopperAdditionalPhones"
5996   },
5997   {
5998     "type": "post",
5999     "url": "/api/cm/companies",
6000     "title": "Creates a new Company",
6001     "examples": [
6002       {
6003         "title": "Example usage:",
6004         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6005         "type": "json"
6006       }
6007     ],
6008     "name": "CreateCompanies",
6009     "group": "Cm_Companies",
6010     "parameter": {
6011       "fields": {
6012         "Body": [
6013           {
6014             "group": "Body",
6015             "type": "String",
6016             "optional": false,
6017             "field": "name",
6018             "description": ""
6019           },
6020           {
6021             "group": "Body",
6022             "type": "String",
6023             "optional": true,
6024             "field": "vat",
6025             "description": ""
6026           },
6027           {
6028             "group": "Body",
6029             "type": "String",
6030             "optional": true,
6031             "field": "companyId",
6032             "description": ""
6033           },
6034           {
6035             "group": "Body",
6036             "type": "String",
6037             "optional": true,
6038             "field": "website",
6039             "description": ""
6040           },
6041           {
6042             "group": "Body",
6043             "type": "String",
6044             "optional": true,
6045             "field": "phone",
6046             "description": ""
6047           },
6048           {
6049             "group": "Body",
6050             "type": "String",
6051             "optional": true,
6052             "field": "fax",
6053             "description": ""
6054           },
6055           {
6056             "group": "Body",
6057             "type": "String",
6058             "optional": true,
6059             "field": "type",
6060             "description": ""
6061           },
6062           {
6063             "group": "Body",
6064             "type": "String",
6065             "optional": true,
6066             "field": "street",
6067             "description": ""
6068           },
6069           {
6070             "group": "Body",
6071             "type": "String",
6072             "optional": true,
6073             "field": "postalCode",
6074             "description": ""
6075           },
6076           {
6077             "group": "Body",
6078             "type": "String",
6079             "optional": true,
6080             "field": "city",
6081             "description": ""
6082           },
6083           {
6084             "group": "Body",
6085             "type": "String",
6086             "optional": true,
6087             "field": "country",
6088             "description": ""
6089           },
6090           {
6091             "group": "Body",
6092             "type": "String",
6093             "optional": true,
6094             "field": "email",
6095             "description": ""
6096           },
6097           {
6098             "group": "Body",
6099             "type": "String",
6100             "optional": true,
6101             "field": "emailDomain",
6102             "description": ""
6103           },
6104           {
6105             "group": "Body",
6106             "type": "String",
6107             "optional": true,
6108             "field": "sStreet",
6109             "description": ""
6110           },
6111           {
6112             "group": "Body",
6113             "type": "String",
6114             "optional": true,
6115             "field": "sPostalCode",
6116             "description": ""
6117           },
6118           {
6119             "group": "Body",
6120             "type": "String",
6121             "optional": true,
6122             "field": "sCity",
6123             "description": ""
6124           },
6125           {
6126             "group": "Body",
6127             "type": "String",
6128             "optional": true,
6129             "field": "sCountry",
6130             "description": ""
6131           },
6132           {
6133             "group": "Body",
6134             "type": "String",
6135             "optional": true,
6136             "field": "description",
6137             "description": ""
6138           }
6139         ]
6140       }
6141     },
6142     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6143     "version": "0.0.0",
6144     "filename": "server/api/cmCompany/index.js",
6145     "groupTitle": "Cm_Companies"
6146   },
6147   {
6148     "type": "delete",
6149     "url": "/api/cm/companies/{id}",
6150     "title": "Deletes a Company",
6151     "examples": [
6152       {
6153         "title": "Example usage:",
6154         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
6155         "type": "json"
6156       }
6157     ],
6158     "name": "DeleteCompanies",
6159     "group": "Cm_Companies",
6160     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6161     "version": "0.0.0",
6162     "filename": "server/api/cmCompany/index.js",
6163     "groupTitle": "Cm_Companies"
6164   },
6165   {
6166     "type": "get",
6167     "url": "/api/cm/companies/describe",
6168     "title": "Gets table info about Companies",
6169     "examples": [
6170       {
6171         "title": "Example usage:",
6172         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6173         "type": "json"
6174       }
6175     ],
6176     "name": "DescribeCompanies",
6177     "group": "Cm_Companies",
6178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6179     "version": "0.0.0",
6180     "filename": "server/api/cmCompany/index.js",
6181     "groupTitle": "Cm_Companies"
6182   },
6183   {
6184     "type": "get",
6185     "url": "/api/cm/companies",
6186     "title": "Gets a list of Companies",
6187     "examples": [
6188       {
6189         "title": "Example usage:",
6190         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6191         "type": "json"
6192       }
6193     ],
6194     "name": "GetCompanies",
6195     "group": "Cm_Companies",
6196     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6197     "version": "0.0.0",
6198     "filename": "server/api/cmCompany/index.js",
6199     "groupTitle": "Cm_Companies"
6200   },
6201   {
6202     "type": "get",
6203     "url": "/api/cm/companies/{id}",
6204     "title": "Gets a single Company",
6205     "examples": [
6206       {
6207         "title": "Example usage:",
6208         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6209         "type": "json"
6210       }
6211     ],
6212     "name": "ShowCompanies",
6213     "group": "Cm_Companies",
6214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6215     "version": "0.0.0",
6216     "filename": "server/api/cmCompany/index.js",
6217     "groupTitle": "Cm_Companies"
6218   },
6219   {
6220     "type": "post",
6221     "url": "/api/cm/companies/{id}/contacts",
6222     "title": "Creates new contacts",
6223     "examples": [
6224       {
6225         "title": "Example usage:",
6226         "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",
6227         "type": "json"
6228       }
6229     ],
6230     "name": "addContacts",
6231     "group": "Cm_Companies",
6232     "parameter": {
6233       "fields": {
6234         "Body": [
6235           {
6236             "group": "Body",
6237             "type": "String",
6238             "optional": false,
6239             "field": "firstName",
6240             "description": ""
6241           },
6242           {
6243             "group": "Body",
6244             "type": "String",
6245             "optional": true,
6246             "field": "lastName",
6247             "description": ""
6248           },
6249           {
6250             "group": "Body",
6251             "type": "String",
6252             "optional": true,
6253             "field": "street",
6254             "description": ""
6255           },
6256           {
6257             "group": "Body",
6258             "type": "String",
6259             "optional": true,
6260             "field": "postalCode",
6261             "description": ""
6262           },
6263           {
6264             "group": "Body",
6265             "type": "String",
6266             "optional": true,
6267             "field": "city",
6268             "description": ""
6269           },
6270           {
6271             "group": "Body",
6272             "type": "String",
6273             "optional": true,
6274             "field": "country",
6275             "description": ""
6276           },
6277           {
6278             "group": "Body",
6279             "type": "String",
6280             "optional": true,
6281             "field": "dateOfBirth",
6282             "description": ""
6283           },
6284           {
6285             "group": "Body",
6286             "type": "Text",
6287             "optional": true,
6288             "field": "description",
6289             "description": ""
6290           },
6291           {
6292             "group": "Body",
6293             "type": "String",
6294             "optional": true,
6295             "field": "phone",
6296             "description": ""
6297           },
6298           {
6299             "group": "Body",
6300             "type": "String",
6301             "optional": true,
6302             "field": "mobile",
6303             "description": ""
6304           },
6305           {
6306             "group": "Body",
6307             "type": "String",
6308             "optional": true,
6309             "field": "fax",
6310             "description": ""
6311           },
6312           {
6313             "group": "Body",
6314             "type": "String",
6315             "optional": true,
6316             "field": "email",
6317             "description": ""
6318           },
6319           {
6320             "group": "Body",
6321             "type": "String",
6322             "optional": true,
6323             "field": "url",
6324             "description": ""
6325           },
6326           {
6327             "group": "Body",
6328             "type": "String",
6329             "optional": true,
6330             "field": "facebook",
6331             "description": ""
6332           },
6333           {
6334             "group": "Body",
6335             "type": "String",
6336             "optional": true,
6337             "field": "fb_data",
6338             "description": ""
6339           },
6340           {
6341             "group": "Body",
6342             "type": "String",
6343             "optional": true,
6344             "field": "twitter",
6345             "description": ""
6346           },
6347           {
6348             "group": "Body",
6349             "type": "String",
6350             "optional": true,
6351             "field": "skype",
6352             "description": ""
6353           },
6354           {
6355             "group": "Body",
6356             "type": "String",
6357             "optional": true,
6358             "field": "teams",
6359             "description": ""
6360           },
6361           {
6362             "group": "Body",
6363             "type": "String",
6364             "optional": true,
6365             "field": "viber",
6366             "description": ""
6367           },
6368           {
6369             "group": "Body",
6370             "type": "String",
6371             "optional": true,
6372             "field": "line",
6373             "description": ""
6374           },
6375           {
6376             "group": "Body",
6377             "type": "String",
6378             "optional": true,
6379             "field": "wechat",
6380             "description": ""
6381           },
6382           {
6383             "group": "Body",
6384             "type": "String",
6385             "optional": true,
6386             "field": "telegram",
6387             "description": ""
6388           },
6389           {
6390             "group": "Body",
6391             "type": "Integer",
6392             "optional": true,
6393             "field": "UserId",
6394             "description": ""
6395           },
6396           {
6397             "group": "Body",
6398             "type": "Integer",
6399             "optional": true,
6400             "field": "priority",
6401             "description": ""
6402           },
6403           {
6404             "group": "Body",
6405             "type": "String",
6406             "optional": true,
6407             "field": "scheduledat",
6408             "description": ""
6409           }
6410         ]
6411       }
6412     },
6413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6414     "version": "0.0.0",
6415     "filename": "server/api/cmCompany/index.js",
6416     "groupTitle": "Cm_Companies"
6417   },
6418   {
6419     "type": "get",
6420     "url": "/api/cm/companies/{id}/contacts",
6421     "title": "Gets List Contacts",
6422     "examples": [
6423       {
6424         "title": "Example usage:",
6425         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6426         "type": "json"
6427       }
6428     ],
6429     "name": "getContacts",
6430     "group": "Cm_Companies",
6431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6432     "version": "0.0.0",
6433     "filename": "server/api/cmCompany/index.js",
6434     "groupTitle": "Cm_Companies"
6435   },
6436   {
6437     "type": "put",
6438     "url": "/api/cm/companies/{id}",
6439     "title": "Update an existing Company",
6440     "examples": [
6441       {
6442         "title": "Example usage:",
6443         "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",
6444         "type": "json"
6445       }
6446     ],
6447     "name": "updateCompanies",
6448     "group": "Cm_Companies",
6449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6450     "version": "0.0.0",
6451     "filename": "server/api/cmCompany/index.js",
6452     "groupTitle": "Cm_Companies"
6453   },
6454   {
6455     "type": "delete",
6456     "url": "/api/cm/contacts/{id}",
6457     "title": "Deletes a Contact",
6458     "examples": [
6459       {
6460         "title": "Example usage:",
6461         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6462         "type": "json"
6463       }
6464     ],
6465     "name": "DeleteContacts",
6466     "group": "Cm_Contacts",
6467     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6468     "version": "0.0.0",
6469     "filename": "server/api/cmContact/index.js",
6470     "groupTitle": "Cm_Contacts"
6471   },
6472   {
6473     "type": "get",
6474     "url": "/api/cm/contacts/describe",
6475     "title": "Gets table info about Contacts",
6476     "examples": [
6477       {
6478         "title": "Example usage:",
6479         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6480         "type": "json"
6481       }
6482     ],
6483     "name": "DescribeContacts",
6484     "group": "Cm_Contacts",
6485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6486     "version": "0.0.0",
6487     "filename": "server/api/cmContact/index.js",
6488     "groupTitle": "Cm_Contacts"
6489   },
6490   {
6491     "type": "get",
6492     "url": "/api/cm/contacts",
6493     "title": "Gets a list of Contacts",
6494     "examples": [
6495       {
6496         "title": "Example usage:",
6497         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6498         "type": "json"
6499       }
6500     ],
6501     "name": "GetContacts",
6502     "group": "Cm_Contacts",
6503     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6504     "version": "0.0.0",
6505     "filename": "server/api/cmContact/index.js",
6506     "groupTitle": "Cm_Contacts"
6507   },
6508   {
6509     "type": "get",
6510     "url": "/api/cm/contacts/{id}/finals",
6511     "title": "Gets contact hopper finals",
6512     "examples": [
6513       {
6514         "title": "Example usage:",
6515         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6516         "type": "json"
6517       }
6518     ],
6519     "name": "GetHopperFinals",
6520     "group": "Cm_Contacts",
6521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6522     "version": "0.0.0",
6523     "filename": "server/api/cmContact/index.js",
6524     "groupTitle": "Cm_Contacts"
6525   },
6526   {
6527     "type": "get",
6528     "url": "/api/cm/contacts/{id}/hopper_histories",
6529     "title": "Gets contact hopper histories",
6530     "examples": [
6531       {
6532         "title": "Example usage:",
6533         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6534         "type": "json"
6535       }
6536     ],
6537     "name": "GetHopperHistories",
6538     "group": "Cm_Contacts",
6539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6540     "version": "0.0.0",
6541     "filename": "server/api/cmContact/index.js",
6542     "groupTitle": "Cm_Contacts"
6543   },
6544   {
6545     "type": "get",
6546     "url": "/api/cm/contacts/{id}/hoppers",
6547     "title": "Gets contact hoppers",
6548     "examples": [
6549       {
6550         "title": "Example usage:",
6551         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6552         "type": "json"
6553       }
6554     ],
6555     "name": "GetHoppers",
6556     "group": "Cm_Contacts",
6557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6558     "version": "0.0.0",
6559     "filename": "server/api/cmContact/index.js",
6560     "groupTitle": "Cm_Contacts"
6561   },
6562   {
6563     "type": "post",
6564     "url": "/api/cm/contacts/create_many",
6565     "title": "Create Contacts",
6566     "examples": [
6567       {
6568         "title": "Example usage:",
6569         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6570         "type": "json"
6571       }
6572     ],
6573     "name": "bulkCreate",
6574     "group": "Cm_Contacts",
6575     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6576     "version": "0.0.0",
6577     "filename": "server/api/cmContact/index.js",
6578     "groupTitle": "Cm_Contacts"
6579   },
6580   {
6581     "type": "post",
6582     "url": "/api/cm/contacts",
6583     "title": "Create Contact",
6584     "examples": [
6585       {
6586         "title": "Example usage:",
6587         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6588         "type": "json"
6589       }
6590     ],
6591     "name": "create",
6592     "group": "Cm_Contacts",
6593     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6594     "version": "0.0.0",
6595     "filename": "server/api/cmContact/index.js",
6596     "groupTitle": "Cm_Contacts"
6597   },
6598   {
6599     "type": "post",
6600     "url": "/api/cm/contacts/{id}/duplicatePhones",
6601     "title": "Sets new contact additional phones",
6602     "examples": [
6603       {
6604         "title": "Example usage:",
6605         "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6606         "type": "json"
6607       }
6608     ],
6609     "name": "duplicateAdditionalPhones",
6610     "group": "Cm_Contacts",
6611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6612     "version": "0.0.0",
6613     "filename": "server/api/cmContact/index.js",
6614     "groupTitle": "Cm_Contacts"
6615   },
6616   {
6617     "type": "get",
6618     "url": "/api/cm/contacts/{id}/phones",
6619     "title": "Gets contact phones",
6620     "examples": [
6621       {
6622         "title": "Example usage:",
6623         "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
6624         "type": "json"
6625       }
6626     ],
6627     "name": "getAdditionalPhones",
6628     "group": "Cm_Contacts",
6629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6630     "version": "0.0.0",
6631     "filename": "server/api/cmContact/index.js",
6632     "groupTitle": "Cm_Contacts"
6633   },
6634   {
6635     "type": "get",
6636     "url": "/api/cm/contacts/{id}/journey",
6637     "title": "Gets customer journey",
6638     "examples": [
6639       {
6640         "title": "Example usage:",
6641         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6642         "type": "json"
6643       }
6644     ],
6645     "name": "getJourney",
6646     "group": "Cm_Contacts",
6647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6648     "version": "0.0.0",
6649     "filename": "server/api/cmContact/index.js",
6650     "groupTitle": "Cm_Contacts"
6651   },
6652   {
6653     "type": "get",
6654     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6655     "title": "Gets contact hopper blacks",
6656     "examples": [
6657       {
6658         "title": "Example usage:",
6659         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6660         "type": "json"
6661       }
6662     ],
6663     "name": "getJscriptySessions",
6664     "group": "Cm_Contacts",
6665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6666     "version": "0.0.0",
6667     "filename": "server/api/cmContact/index.js",
6668     "groupTitle": "Cm_Contacts"
6669   },
6670   {
6671     "type": "get",
6672     "url": "/api/cm/contacts/{id}/tags",
6673     "title": "Gets configurations tags",
6674     "examples": [
6675       {
6676         "title": "Example usage:",
6677         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6678         "type": "json"
6679       }
6680     ],
6681     "name": "getTags",
6682     "group": "Cm_Contacts",
6683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6684     "version": "0.0.0",
6685     "filename": "server/api/cmContact/index.js",
6686     "groupTitle": "Cm_Contacts"
6687   },
6688   {
6689     "type": "post",
6690     "url": "/api/cm/contacts/merge",
6691     "title": "Merge Contact",
6692     "examples": [
6693       {
6694         "title": "Example usage:",
6695         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6696         "type": "json"
6697       }
6698     ],
6699     "name": "merge",
6700     "group": "Cm_Contacts",
6701     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6702     "version": "0.0.0",
6703     "filename": "server/api/cmContact/index.js",
6704     "groupTitle": "Cm_Contacts"
6705   },
6706   {
6707     "type": "post",
6708     "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
6709     "title": "Sets new contact additional phones",
6710     "examples": [
6711       {
6712         "title": "Example usage:",
6713         "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6714         "type": "json"
6715       }
6716     ],
6717     "name": "rescheduleAdditionalPhones",
6718     "group": "Cm_Contacts",
6719     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6720     "version": "0.0.0",
6721     "filename": "server/api/cmContact/index.js",
6722     "groupTitle": "Cm_Contacts"
6723   },
6724   {
6725     "type": "post",
6726     "url": "/api/cm/contacts/{id}/phones",
6727     "title": "Sets new contact phones",
6728     "examples": [
6729       {
6730         "title": "Example usage:",
6731         "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6732         "type": "json"
6733       }
6734     ],
6735     "name": "setAdditionalPhones",
6736     "group": "Cm_Contacts",
6737     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6738     "version": "0.0.0",
6739     "filename": "server/api/cmContact/index.js",
6740     "groupTitle": "Cm_Contacts"
6741   },
6742   {
6743     "type": "post",
6744     "url": "/api/cm/contacts/{id}/tags",
6745     "title": "Sets new tags",
6746     "examples": [
6747       {
6748         "title": "Example usage:",
6749         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6750         "type": "json"
6751       }
6752     ],
6753     "name": "setTags",
6754     "group": "Cm_Contacts",
6755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6756     "version": "0.0.0",
6757     "filename": "server/api/cmContact/index.js",
6758     "groupTitle": "Cm_Contacts"
6759   },
6760   {
6761     "type": "get",
6762     "url": "/api/cm/contacts/{id}",
6763     "title": "Gets a single Contact",
6764     "examples": [
6765       {
6766         "title": "Example usage:",
6767         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6768         "type": "json"
6769       }
6770     ],
6771     "name": "show",
6772     "group": "Cm_Contacts",
6773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6774     "version": "0.0.0",
6775     "filename": "server/api/cmContact/index.js",
6776     "groupTitle": "Cm_Contacts"
6777   },
6778   {
6779     "type": "put",
6780     "url": "/api/cm/contacts/{id}",
6781     "title": "Update a single Contact",
6782     "examples": [
6783       {
6784         "title": "Example usage:",
6785         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6786         "type": "json"
6787       }
6788     ],
6789     "name": "update",
6790     "group": "Cm_Contacts",
6791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6792     "version": "0.0.0",
6793     "filename": "server/api/cmContact/index.js",
6794     "groupTitle": "Cm_Contacts"
6795   },
6796   {
6797     "type": "delete",
6798     "url": "/api/cm/custom_fields/{id}",
6799     "title": "Deletes a Custom Field",
6800     "examples": [
6801       {
6802         "title": "Example usage:",
6803         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6804         "type": "json"
6805       }
6806     ],
6807     "name": "DeleteCustom_Fields",
6808     "group": "Cm_Custom_Fields",
6809     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6810     "version": "0.0.0",
6811     "filename": "server/api/cmCustomField/index.js",
6812     "groupTitle": "Cm_Custom_Fields"
6813   },
6814   {
6815     "type": "get",
6816     "url": "/api/cm/custom_fields",
6817     "title": "Gets a list of Custom Fields",
6818     "examples": [
6819       {
6820         "title": "Example usage:",
6821         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6822         "type": "json"
6823       }
6824     ],
6825     "name": "GetCustom_Fields",
6826     "group": "Cm_Custom_Fields",
6827     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6828     "version": "0.0.0",
6829     "filename": "server/api/cmCustomField/index.js",
6830     "groupTitle": "Cm_Custom_Fields"
6831   },
6832   {
6833     "type": "get",
6834     "url": "/api/cm/custom_fields/{id}",
6835     "title": "Gets a single Custom Field",
6836     "examples": [
6837       {
6838         "title": "Example usage:",
6839         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6840         "type": "json"
6841       }
6842     ],
6843     "name": "ShowCustom_Fields",
6844     "group": "Cm_Custom_Fields",
6845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6846     "version": "0.0.0",
6847     "filename": "server/api/cmCustomField/index.js",
6848     "groupTitle": "Cm_Custom_Fields"
6849   },
6850   {
6851     "type": "put",
6852     "url": "/api/cm/custom_fields/{id}",
6853     "title": "Update an existing Custom Field",
6854     "examples": [
6855       {
6856         "title": "Example usage:",
6857         "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",
6858         "type": "json"
6859       }
6860     ],
6861     "name": "updateCustom_Fields",
6862     "group": "Cm_Custom_Fields",
6863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6864     "version": "0.0.0",
6865     "filename": "server/api/cmCustomField/index.js",
6866     "groupTitle": "Cm_Custom_Fields"
6867   },
6868   {
6869     "type": "post",
6870     "url": "/api/cm/hopper",
6871     "title": "Creates a new Hopper",
6872     "examples": [
6873       {
6874         "title": "Example usage:",
6875         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6876         "type": "json"
6877       }
6878     ],
6879     "name": "CreateHopper",
6880     "group": "Cm_Hopper",
6881     "parameter": {
6882       "fields": {
6883         "Body": [
6884           {
6885             "group": "Body",
6886             "type": "String",
6887             "optional": false,
6888             "field": "phone",
6889             "description": ""
6890           },
6891           {
6892             "group": "Body",
6893             "type": "Boolean",
6894             "optional": true,
6895             "field": "active",
6896             "description": ""
6897           },
6898           {
6899             "group": "Body",
6900             "type": "String",
6901             "optional": true,
6902             "field": "scheduledat",
6903             "description": ""
6904           },
6905           {
6906             "group": "Body",
6907             "type": "Integer",
6908             "optional": true,
6909             "field": "countbusyretry",
6910             "description": ""
6911           },
6912           {
6913             "group": "Body",
6914             "type": "Integer",
6915             "optional": true,
6916             "field": "countcongestionretry",
6917             "description": ""
6918           },
6919           {
6920             "group": "Body",
6921             "type": "Integer",
6922             "optional": true,
6923             "field": "countnoanswerretry",
6924             "description": ""
6925           },
6926           {
6927             "group": "Body",
6928             "type": "Boolean",
6929             "optional": true,
6930             "field": "callback",
6931             "description": ""
6932           },
6933           {
6934             "group": "Body",
6935             "type": "String",
6936             "optional": true,
6937             "field": "callbackuniqueid",
6938             "description": ""
6939           },
6940           {
6941             "group": "Body",
6942             "type": "String",
6943             "optional": true,
6944             "field": "callbackat",
6945             "description": ""
6946           },
6947           {
6948             "group": "Body",
6949             "type": "Integer",
6950             "optional": true,
6951             "field": "priority",
6952             "description": ""
6953           },
6954           {
6955             "group": "Body",
6956             "type": "Boolean",
6957             "optional": true,
6958             "field": "recallme",
6959             "description": ""
6960           },
6961           {
6962             "group": "Body",
6963             "type": "Integer",
6964             "optional": true,
6965             "field": "ContactId",
6966             "description": ""
6967           },
6968           {
6969             "group": "Body",
6970             "type": "Integer",
6971             "optional": true,
6972             "field": "ListId",
6973             "description": ""
6974           },
6975           {
6976             "group": "Body",
6977             "type": "Integer",
6978             "optional": true,
6979             "field": "UserId",
6980             "description": ""
6981           },
6982           {
6983             "group": "Body",
6984             "type": "Integer",
6985             "optional": true,
6986             "field": "VoiceQueueId",
6987             "description": ""
6988           },
6989           {
6990             "group": "Body",
6991             "type": "Integer",
6992             "optional": true,
6993             "field": "CampaignId",
6994             "description": ""
6995           },
6996           {
6997             "group": "Body",
6998             "type": "Integer",
6999             "optional": true,
7000             "field": "countnosuchnumberretry",
7001             "description": ""
7002           },
7003           {
7004             "group": "Body",
7005             "type": "Integer",
7006             "optional": true,
7007             "field": "countdropretry",
7008             "description": ""
7009           },
7010           {
7011             "group": "Body",
7012             "type": "Integer",
7013             "optional": true,
7014             "field": "countabandonedretry",
7015             "description": ""
7016           },
7017           {
7018             "group": "Body",
7019             "type": "Integer",
7020             "optional": true,
7021             "field": "countmachineretry",
7022             "description": ""
7023           },
7024           {
7025             "group": "Body",
7026             "type": "Integer",
7027             "optional": true,
7028             "field": "countagentrejectretry",
7029             "description": ""
7030           },
7031           {
7032             "group": "Body",
7033             "type": "Integer",
7034             "optional": true,
7035             "field": "OrderBy",
7036             "description": ""
7037           },
7038           {
7039             "group": "Body",
7040             "type": "String",
7041             "optional": true,
7042             "field": "dialTimezone",
7043             "description": ""
7044           }
7045         ]
7046       }
7047     },
7048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7049     "version": "0.0.0",
7050     "filename": "server/api/cmHopper/index.js",
7051     "groupTitle": "Cm_Hopper"
7052   },
7053   {
7054     "type": "get",
7055     "url": "/api/cm/hopper/describe",
7056     "title": "Gets table info about Hopper",
7057     "examples": [
7058       {
7059         "title": "Example usage:",
7060         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
7061         "type": "json"
7062       }
7063     ],
7064     "name": "DescribeHopper",
7065     "group": "Cm_Hopper",
7066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7067     "version": "0.0.0",
7068     "filename": "server/api/cmHopper/index.js",
7069     "groupTitle": "Cm_Hopper"
7070   },
7071   {
7072     "type": "get",
7073     "url": "/api/cm/hopper",
7074     "title": "Gets a list of Hopper",
7075     "examples": [
7076       {
7077         "title": "Example usage:",
7078         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
7079         "type": "json"
7080       }
7081     ],
7082     "name": "GetHopper",
7083     "group": "Cm_Hopper",
7084     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7085     "version": "0.0.0",
7086     "filename": "server/api/cmHopper/index.js",
7087     "groupTitle": "Cm_Hopper"
7088   },
7089   {
7090     "type": "get",
7091     "url": "/api/cm/hopper/{id}",
7092     "title": "Gets a single Hopper",
7093     "examples": [
7094       {
7095         "title": "Example usage:",
7096         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
7097         "type": "json"
7098       }
7099     ],
7100     "name": "ShowHopper",
7101     "group": "Cm_Hopper",
7102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7103     "version": "0.0.0",
7104     "filename": "server/api/cmHopper/index.js",
7105     "groupTitle": "Cm_Hopper"
7106   },
7107   {
7108     "type": "delete",
7109     "url": "/api/cm/hopper_black/{id}",
7110     "title": "Deletes a Hopper Black",
7111     "examples": [
7112       {
7113         "title": "Example usage:",
7114         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
7115         "type": "json"
7116       }
7117     ],
7118     "name": "DeleteHopper_Black",
7119     "group": "Cm_Hopper_Black",
7120     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7121     "version": "0.0.0",
7122     "filename": "server/api/cmHopperBlack/index.js",
7123     "groupTitle": "Cm_Hopper_Black"
7124   },
7125   {
7126     "type": "get",
7127     "url": "/api/cm/hopper_black/describe",
7128     "title": "Gets table info about Hopper Black",
7129     "examples": [
7130       {
7131         "title": "Example usage:",
7132         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
7133         "type": "json"
7134       }
7135     ],
7136     "name": "DescribeHopper_Black",
7137     "group": "Cm_Hopper_Black",
7138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7139     "version": "0.0.0",
7140     "filename": "server/api/cmHopperBlack/index.js",
7141     "groupTitle": "Cm_Hopper_Black"
7142   },
7143   {
7144     "type": "get",
7145     "url": "/api/cm/hopper_black",
7146     "title": "Gets a list of Hopper Black",
7147     "examples": [
7148       {
7149         "title": "Example usage:",
7150         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7151         "type": "json"
7152       }
7153     ],
7154     "name": "GetHopper_Black",
7155     "group": "Cm_Hopper_Black",
7156     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7157     "version": "0.0.0",
7158     "filename": "server/api/cmHopperBlack/index.js",
7159     "groupTitle": "Cm_Hopper_Black"
7160   },
7161   {
7162     "type": "get",
7163     "url": "/api/cm/hopper_black/{id}",
7164     "title": "Gets a single Hopper Black",
7165     "examples": [
7166       {
7167         "title": "Example usage:",
7168         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7169         "type": "json"
7170       }
7171     ],
7172     "name": "ShowHopper_Black",
7173     "group": "Cm_Hopper_Black",
7174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7175     "version": "0.0.0",
7176     "filename": "server/api/cmHopperBlack/index.js",
7177     "groupTitle": "Cm_Hopper_Black"
7178   },
7179   {
7180     "type": "put",
7181     "url": "/api/cm/hopper_black/{id}",
7182     "title": "Update an existing Hopper Black",
7183     "examples": [
7184       {
7185         "title": "Example usage:",
7186         "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",
7187         "type": "json"
7188       }
7189     ],
7190     "name": "updateHopper_Black",
7191     "group": "Cm_Hopper_Black",
7192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7193     "version": "0.0.0",
7194     "filename": "server/api/cmHopperBlack/index.js",
7195     "groupTitle": "Cm_Hopper_Black"
7196   },
7197   {
7198     "type": "post",
7199     "url": "/api/cm/hopper_final/checkContactHopper",
7200     "title": "Check if contact is in hopper",
7201     "examples": [
7202       {
7203         "title": "Example usage:",
7204         "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",
7205         "type": "json"
7206       }
7207     ],
7208     "name": "/checkContactHopper",
7209     "group": "Cm_Hopper_Final",
7210     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7211     "version": "0.0.0",
7212     "filename": "server/api/cmHopperFinal/index.js",
7213     "groupTitle": "Cm_Hopper_Final"
7214   },
7215   {
7216     "type": "get",
7217     "url": "/api/cm/hopper_final/describe",
7218     "title": "Gets table info about HopperFinal",
7219     "examples": [
7220       {
7221         "title": "Example usage:",
7222         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7223         "type": "json"
7224       }
7225     ],
7226     "name": "DescribeHopperFinal",
7227     "group": "Cm_Hopper_Final",
7228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7229     "version": "0.0.0",
7230     "filename": "server/api/cmHopperFinal/index.js",
7231     "groupTitle": "Cm_Hopper_Final"
7232   },
7233   {
7234     "type": "get",
7235     "url": "/api/cm/hopper_final",
7236     "title": "Gets a list of HopperFinal",
7237     "examples": [
7238       {
7239         "title": "Example usage:",
7240         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7241         "type": "json"
7242       }
7243     ],
7244     "name": "GetHopperFinal",
7245     "group": "Cm_Hopper_Final",
7246     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7247     "version": "0.0.0",
7248     "filename": "server/api/cmHopperFinal/index.js",
7249     "groupTitle": "Cm_Hopper_Final"
7250   },
7251   {
7252     "type": "get",
7253     "url": "/api/cm/hopper_final/{id}",
7254     "title": "Gets a single HopperFinal",
7255     "examples": [
7256       {
7257         "title": "Example usage:",
7258         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7259         "type": "json"
7260       }
7261     ],
7262     "name": "ShowHopperFinal",
7263     "group": "Cm_Hopper_Final",
7264     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7265     "version": "0.0.0",
7266     "filename": "server/api/cmHopperFinal/index.js",
7267     "groupTitle": "Cm_Hopper_Final"
7268   },
7269   {
7270     "type": "get",
7271     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7272     "title": "Return number contacts for attributes",
7273     "examples": [
7274       {
7275         "title": "Example usage:",
7276         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7277         "type": "json"
7278       }
7279     ],
7280     "name": "countContactsIvrCampaignHopperFinal",
7281     "group": "Cm_Hopper_Final",
7282     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7283     "version": "0.0.0",
7284     "filename": "server/api/cmHopperFinal/index.js",
7285     "groupTitle": "Cm_Hopper_Final"
7286   },
7287   {
7288     "type": "get",
7289     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7290     "title": "Return number contacts for attributes",
7291     "examples": [
7292       {
7293         "title": "Example usage:",
7294         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7295         "type": "json"
7296       }
7297     ],
7298     "name": "countContactsQueueCampaignHopperFinal",
7299     "group": "Cm_Hopper_Final",
7300     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7301     "version": "0.0.0",
7302     "filename": "server/api/cmHopperFinal/index.js",
7303     "groupTitle": "Cm_Hopper_Final"
7304   },
7305   {
7306     "type": "post",
7307     "url": "/api/cm/hopper_final/campaign/{id}",
7308     "title": "Move contacts in hopper",
7309     "examples": [
7310       {
7311         "title": "Example usage:",
7312         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7313         "type": "json"
7314       }
7315     ],
7316     "name": "moveContactsIvrCampaignHopperFinal",
7317     "group": "Cm_Hopper_Final",
7318     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7319     "version": "0.0.0",
7320     "filename": "server/api/cmHopperFinal/index.js",
7321     "groupTitle": "Cm_Hopper_Final"
7322   },
7323   {
7324     "type": "post",
7325     "url": "/api/cm/hopper_final/voice/queue/{id}",
7326     "title": "Move contacts in hopper",
7327     "examples": [
7328       {
7329         "title": "Example usage:",
7330         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7331         "type": "json"
7332       }
7333     ],
7334     "name": "moveContactsQueueCampaignHopperFinal",
7335     "group": "Cm_Hopper_Final",
7336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7337     "version": "0.0.0",
7338     "filename": "server/api/cmHopperFinal/index.js",
7339     "groupTitle": "Cm_Hopper_Final"
7340   },
7341   {
7342     "type": "put",
7343     "url": "/api/cm/hopper_final/{id}",
7344     "title": "Update a single hopper final",
7345     "examples": [
7346       {
7347         "title": "Example usage:",
7348         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7349         "type": "json"
7350       }
7351     ],
7352     "name": "update",
7353     "group": "Cm_Hopper_Final",
7354     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7355     "version": "0.0.0",
7356     "filename": "server/api/cmHopperFinal/index.js",
7357     "groupTitle": "Cm_Hopper_Final"
7358   },
7359   {
7360     "type": "post",
7361     "url": "/api/cm/hopper_history",
7362     "title": "Creates a new HopperHistory",
7363     "examples": [
7364       {
7365         "title": "Example usage:",
7366         "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",
7367         "type": "json"
7368       }
7369     ],
7370     "name": "CreateHopperHistory",
7371     "group": "Cm_Hopper_History",
7372     "parameter": {
7373       "fields": {
7374         "Body": [
7375           {
7376             "group": "Body",
7377             "type": "Integer",
7378             "optional": true,
7379             "field": "state",
7380             "description": ""
7381           },
7382           {
7383             "group": "Body",
7384             "type": "String",
7385             "optional": true,
7386             "field": "statedesc",
7387             "description": ""
7388           },
7389           {
7390             "group": "Body",
7391             "type": "String",
7392             "optional": true,
7393             "field": "scheduledat",
7394             "description": ""
7395           },
7396           {
7397             "group": "Body",
7398             "type": "Integer",
7399             "optional": true,
7400             "field": "countbusyretry",
7401             "description": ""
7402           },
7403           {
7404             "group": "Body",
7405             "type": "Integer",
7406             "optional": true,
7407             "field": "countcongestionretry",
7408             "description": ""
7409           },
7410           {
7411             "group": "Body",
7412             "type": "Integer",
7413             "optional": true,
7414             "field": "countnoanswerretry",
7415             "description": ""
7416           },
7417           {
7418             "group": "Body",
7419             "type": "Integer",
7420             "optional": true,
7421             "field": "countglobal",
7422             "description": ""
7423           },
7424           {
7425             "group": "Body",
7426             "type": "String",
7427             "optional": true,
7428             "field": "uniqueid",
7429             "description": ""
7430           },
7431           {
7432             "group": "Body",
7433             "type": "String",
7434             "optional": true,
7435             "field": "originatecalleridnum",
7436             "description": ""
7437           },
7438           {
7439             "group": "Body",
7440             "type": "String",
7441             "optional": true,
7442             "field": "originatecalleridname",
7443             "description": ""
7444           },
7445           {
7446             "group": "Body",
7447             "type": "String",
7448             "optional": true,
7449             "field": "calleridnum",
7450             "description": ""
7451           },
7452           {
7453             "group": "Body",
7454             "type": "String",
7455             "optional": true,
7456             "field": "calleridname",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "String",
7462             "optional": true,
7463             "field": "starttime",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "String",
7469             "optional": true,
7470             "field": "responsetime",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "answertime",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "droptime",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "String",
7490             "optional": true,
7491             "field": "endtime",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "Integer",
7497             "optional": true,
7498             "field": "ringtime",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "Integer",
7504             "optional": true,
7505             "field": "holdtime",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "Integer",
7511             "optional": true,
7512             "field": "talktime",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "Integer",
7518             "optional": true,
7519             "field": "followuptime",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "dropreason",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "campaign",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "campaigntype",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "membername",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "String",
7553             "optional": true,
7554             "field": "reason",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "Boolean",
7560             "optional": true,
7561             "field": "amd",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "Boolean",
7567             "optional": true,
7568             "field": "fax",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "Boolean",
7574             "optional": true,
7575             "field": "callback",
7576             "description": ""
7577           },
7578           {
7579             "group": "Body",
7580             "type": "String",
7581             "optional": true,
7582             "field": "callbackuniqueid",
7583             "description": ""
7584           },
7585           {
7586             "group": "Body",
7587             "type": "String",
7588             "optional": true,
7589             "field": "callbackat",
7590             "description": ""
7591           },
7592           {
7593             "group": "Body",
7594             "type": "Boolean",
7595             "optional": true,
7596             "field": "recallme",
7597             "description": ""
7598           },
7599           {
7600             "group": "Body",
7601             "type": "String",
7602             "optional": true,
7603             "field": "editedat",
7604             "description": ""
7605           },
7606           {
7607             "group": "Body",
7608             "type": "Boolean",
7609             "optional": true,
7610             "field": "edited",
7611             "description": ""
7612           },
7613           {
7614             "group": "Body",
7615             "type": "Integer",
7616             "optional": true,
7617             "field": "countnosuchnumberretry",
7618             "description": ""
7619           },
7620           {
7621             "group": "Body",
7622             "type": "Integer",
7623             "optional": true,
7624             "field": "countdropretry",
7625             "description": ""
7626           },
7627           {
7628             "group": "Body",
7629             "type": "Integer",
7630             "optional": true,
7631             "field": "countabandonedretry",
7632             "description": ""
7633           },
7634           {
7635             "group": "Body",
7636             "type": "Integer",
7637             "optional": true,
7638             "field": "countmachineretry",
7639             "description": ""
7640           },
7641           {
7642             "group": "Body",
7643             "type": "Integer",
7644             "optional": true,
7645             "field": "countagentrejectretry",
7646             "description": ""
7647           }
7648         ]
7649       }
7650     },
7651     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7652     "version": "0.0.0",
7653     "filename": "server/api/cmHopperHistory/index.js",
7654     "groupTitle": "Cm_Hopper_History"
7655   },
7656   {
7657     "type": "get",
7658     "url": "/api/cm/hopper_history/describe",
7659     "title": "Gets table info about HopperHistory",
7660     "examples": [
7661       {
7662         "title": "Example usage:",
7663         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7664         "type": "json"
7665       }
7666     ],
7667     "name": "DescribeHopperHistory",
7668     "group": "Cm_Hopper_History",
7669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7670     "version": "0.0.0",
7671     "filename": "server/api/cmHopperHistory/index.js",
7672     "groupTitle": "Cm_Hopper_History"
7673   },
7674   {
7675     "type": "get",
7676     "url": "/api/cm/hopper_history",
7677     "title": "Gets a list of HopperHistory",
7678     "examples": [
7679       {
7680         "title": "Example usage:",
7681         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7682         "type": "json"
7683       }
7684     ],
7685     "name": "GetHopperHistory",
7686     "group": "Cm_Hopper_History",
7687     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7688     "version": "0.0.0",
7689     "filename": "server/api/cmHopperHistory/index.js",
7690     "groupTitle": "Cm_Hopper_History"
7691   },
7692   {
7693     "type": "get",
7694     "url": "/api/cm/hopper_history/{id}",
7695     "title": "Gets a single HopperHistory",
7696     "examples": [
7697       {
7698         "title": "Example usage:",
7699         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7700         "type": "json"
7701       }
7702     ],
7703     "name": "ShowHopperHistory",
7704     "group": "Cm_Hopper_History",
7705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7706     "version": "0.0.0",
7707     "filename": "server/api/cmHopperHistory/index.js",
7708     "groupTitle": "Cm_Hopper_History"
7709   },
7710   {
7711     "type": "put",
7712     "url": "/api/cm/hopper_history/{id}",
7713     "title": "Update a single hopper history",
7714     "examples": [
7715       {
7716         "title": "Example usage:",
7717         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7718         "type": "json"
7719       }
7720     ],
7721     "name": "update",
7722     "group": "Cm_Hopper_History",
7723     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7724     "version": "0.0.0",
7725     "filename": "server/api/cmHopperHistory/index.js",
7726     "groupTitle": "Cm_Hopper_History"
7727   },
7728   {
7729     "type": "delete",
7730     "url": "/api/cm/hopper/{id}",
7731     "title": "Delete Hopper",
7732     "examples": [
7733       {
7734         "title": "Example usage:",
7735         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7736         "type": "json"
7737       }
7738     ],
7739     "name": "destroy",
7740     "group": "Cm_Hopper",
7741     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7742     "version": "0.0.0",
7743     "filename": "server/api/cmHopper/index.js",
7744     "groupTitle": "Cm_Hopper"
7745   },
7746   {
7747     "type": "get",
7748     "url": "/api/cm/hopper/opencontacts",
7749     "title": "Gets Open Contacts",
7750     "examples": [
7751       {
7752         "title": "Example usage:",
7753         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7754         "type": "json"
7755       }
7756     ],
7757     "name": "getOpenContacts",
7758     "group": "Cm_Hopper",
7759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7760     "version": "0.0.0",
7761     "filename": "server/api/cmHopper/index.js",
7762     "groupTitle": "Cm_Hopper"
7763   },
7764   {
7765     "type": "post",
7766     "url": "/api/cm/hopper/preview",
7767     "title": "Gets Preview Dialer Contacts",
7768     "examples": [
7769       {
7770         "title": "Example usage:",
7771         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7772         "type": "json"
7773       }
7774     ],
7775     "name": "getPreview",
7776     "group": "Cm_Hopper",
7777     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7778     "version": "0.0.0",
7779     "filename": "server/api/cmHopper/index.js",
7780     "groupTitle": "Cm_Hopper"
7781   },
7782   {
7783     "type": "get",
7784     "url": "/api/cm/hopper/{id}/previewrecall",
7785     "title": "Gets Preview Dialer Contacts for Recall",
7786     "examples": [
7787       {
7788         "title": "Example usage:",
7789         "content": "curl https://{domain}/api/cm/hopper/{id}/previewrecall \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7790         "type": "json"
7791       }
7792     ],
7793     "name": "getPreviewRecall",
7794     "group": "Cm_Hopper",
7795     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7796     "version": "0.0.0",
7797     "filename": "server/api/cmHopper/index.js",
7798     "groupTitle": "Cm_Hopper"
7799   },
7800   {
7801     "type": "get",
7802     "url": "/api/cm/hopper/timezones",
7803     "title": "Gets TZs list",
7804     "examples": [
7805       {
7806         "title": "Example usage:",
7807         "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7808         "type": "json"
7809       }
7810     ],
7811     "name": "getTimezones",
7812     "group": "Cm_Hopper",
7813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7814     "version": "0.0.0",
7815     "filename": "server/api/cmHopper/index.js",
7816     "groupTitle": "Cm_Hopper"
7817   },
7818   {
7819     "type": "put",
7820     "url": "/api/cm/hopper/{id}",
7821     "title": "Update an existing Hopper",
7822     "examples": [
7823       {
7824         "title": "Example usage:",
7825         "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",
7826         "type": "json"
7827       }
7828     ],
7829     "name": "updateHopper",
7830     "group": "Cm_Hopper",
7831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7832     "version": "0.0.0",
7833     "filename": "server/api/cmHopper/index.js",
7834     "groupTitle": "Cm_Hopper"
7835   },
7836   {
7837     "type": "post",
7838     "url": "/api/cm/lists",
7839     "title": "Creates a new List",
7840     "examples": [
7841       {
7842         "title": "Example usage:",
7843         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7844         "type": "json"
7845       }
7846     ],
7847     "name": "CreateLists",
7848     "group": "Cm_Lists",
7849     "parameter": {
7850       "fields": {
7851         "Body": [
7852           {
7853             "group": "Body",
7854             "type": "String",
7855             "optional": false,
7856             "field": "name",
7857             "description": ""
7858           },
7859           {
7860             "group": "Body",
7861             "type": "String",
7862             "optional": true,
7863             "field": "description",
7864             "description": ""
7865           },
7866           {
7867             "group": "Body",
7868             "type": "String",
7869             "optional": true,
7870             "field": "dialPrefix",
7871             "description": ""
7872           }
7873         ]
7874       }
7875     },
7876     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7877     "version": "0.0.0",
7878     "filename": "server/api/cmList/index.js",
7879     "groupTitle": "Cm_Lists"
7880   },
7881   {
7882     "type": "delete",
7883     "url": "/api/cm/lists/{id}",
7884     "title": "Deletes a List",
7885     "examples": [
7886       {
7887         "title": "Example usage:",
7888         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7889         "type": "json"
7890       }
7891     ],
7892     "name": "DeleteLists",
7893     "group": "Cm_Lists",
7894     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7895     "version": "0.0.0",
7896     "filename": "server/api/cmList/index.js",
7897     "groupTitle": "Cm_Lists"
7898   },
7899   {
7900     "type": "get",
7901     "url": "/api/cm/lists/describe",
7902     "title": "Gets table info about Lists",
7903     "examples": [
7904       {
7905         "title": "Example usage:",
7906         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7907         "type": "json"
7908       }
7909     ],
7910     "name": "DescribeLists",
7911     "group": "Cm_Lists",
7912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7913     "version": "0.0.0",
7914     "filename": "server/api/cmList/index.js",
7915     "groupTitle": "Cm_Lists"
7916   },
7917   {
7918     "type": "get",
7919     "url": "/api/cm/lists/{id}/users",
7920     "title": "Gets agents from list",
7921     "examples": [
7922       {
7923         "title": "Example usage:",
7924         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7925         "type": "json"
7926       }
7927     ],
7928     "name": "GetAgents",
7929     "group": "Cm_Lists",
7930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7931     "version": "0.0.0",
7932     "filename": "server/api/cmList/index.js",
7933     "groupTitle": "Cm_Lists"
7934   },
7935   {
7936     "type": "get",
7937     "url": "/api/cm/lists",
7938     "title": "Gets a list of Lists",
7939     "examples": [
7940       {
7941         "title": "Example usage:",
7942         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7943         "type": "json"
7944       }
7945     ],
7946     "name": "GetLists",
7947     "group": "Cm_Lists",
7948     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7949     "version": "0.0.0",
7950     "filename": "server/api/cmList/index.js",
7951     "groupTitle": "Cm_Lists"
7952   },
7953   {
7954     "type": "delete",
7955     "url": "/api/cm/lists/{id}/users",
7956     "title": "Removes agents from a list",
7957     "examples": [
7958       {
7959         "title": "Example usage:",
7960         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7961         "type": "json"
7962       }
7963     ],
7964     "name": "RemoveAgents",
7965     "group": "Cm_Lists",
7966     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7967     "version": "0.0.0",
7968     "filename": "server/api/cmList/index.js",
7969     "groupTitle": "Cm_Lists"
7970   },
7971   {
7972     "type": "delete",
7973     "url": "/api/cm/lists/{id}/dispositions",
7974     "title": "Removes dispositions from account",
7975     "examples": [
7976       {
7977         "title": "Example usage:",
7978         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7979         "type": "json"
7980       }
7981     ],
7982     "name": "RemoveDispositions",
7983     "group": "Cm_Lists",
7984     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7985     "version": "0.0.0",
7986     "filename": "server/api/cmList/index.js",
7987     "groupTitle": "Cm_Lists"
7988   },
7989   {
7990     "type": "get",
7991     "url": "/api/cm/lists/{id}",
7992     "title": "Gets a single List",
7993     "examples": [
7994       {
7995         "title": "Example usage:",
7996         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7997         "type": "json"
7998       }
7999     ],
8000     "name": "ShowLists",
8001     "group": "Cm_Lists",
8002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8003     "version": "0.0.0",
8004     "filename": "server/api/cmList/index.js",
8005     "groupTitle": "Cm_Lists"
8006   },
8007   {
8008     "type": "post",
8009     "url": "/api/cm/lists/{id}/users",
8010     "title": "Adds agents to a list",
8011     "examples": [
8012       {
8013         "title": "Example usage:",
8014         "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",
8015         "type": "json"
8016       }
8017     ],
8018     "name": "addAgents",
8019     "group": "Cm_Lists",
8020     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8021     "version": "0.0.0",
8022     "filename": "server/api/cmList/index.js",
8023     "groupTitle": "Cm_Lists"
8024   },
8025   {
8026     "type": "post",
8027     "url": "/api/cm/lists/{id}/contacts",
8028     "title": "Creates new contacts",
8029     "examples": [
8030       {
8031         "title": "Example usage:",
8032         "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",
8033         "type": "json"
8034       }
8035     ],
8036     "name": "addContacts",
8037     "group": "Cm_Lists",
8038     "parameter": {
8039       "fields": {
8040         "Body": [
8041           {
8042             "group": "Body",
8043             "type": "String",
8044             "optional": false,
8045             "field": "firstName",
8046             "description": ""
8047           },
8048           {
8049             "group": "Body",
8050             "type": "String",
8051             "optional": true,
8052             "field": "lastName",
8053             "description": ""
8054           },
8055           {
8056             "group": "Body",
8057             "type": "String",
8058             "optional": true,
8059             "field": "street",
8060             "description": ""
8061           },
8062           {
8063             "group": "Body",
8064             "type": "String",
8065             "optional": true,
8066             "field": "postalCode",
8067             "description": ""
8068           },
8069           {
8070             "group": "Body",
8071             "type": "String",
8072             "optional": true,
8073             "field": "city",
8074             "description": ""
8075           },
8076           {
8077             "group": "Body",
8078             "type": "String",
8079             "optional": true,
8080             "field": "country",
8081             "description": ""
8082           },
8083           {
8084             "group": "Body",
8085             "type": "String",
8086             "optional": true,
8087             "field": "dateOfBirth",
8088             "description": ""
8089           },
8090           {
8091             "group": "Body",
8092             "type": "Text",
8093             "optional": true,
8094             "field": "description",
8095             "description": ""
8096           },
8097           {
8098             "group": "Body",
8099             "type": "String",
8100             "optional": true,
8101             "field": "phone",
8102             "description": ""
8103           },
8104           {
8105             "group": "Body",
8106             "type": "String",
8107             "optional": true,
8108             "field": "mobile",
8109             "description": ""
8110           },
8111           {
8112             "group": "Body",
8113             "type": "String",
8114             "optional": true,
8115             "field": "fax",
8116             "description": ""
8117           },
8118           {
8119             "group": "Body",
8120             "type": "String",
8121             "optional": true,
8122             "field": "email",
8123             "description": ""
8124           },
8125           {
8126             "group": "Body",
8127             "type": "String",
8128             "optional": true,
8129             "field": "url",
8130             "description": ""
8131           },
8132           {
8133             "group": "Body",
8134             "type": "String",
8135             "optional": true,
8136             "field": "facebook",
8137             "description": ""
8138           },
8139           {
8140             "group": "Body",
8141             "type": "String",
8142             "optional": true,
8143             "field": "fb_data",
8144             "description": ""
8145           },
8146           {
8147             "group": "Body",
8148             "type": "String",
8149             "optional": true,
8150             "field": "twitter",
8151             "description": ""
8152           },
8153           {
8154             "group": "Body",
8155             "type": "String",
8156             "optional": true,
8157             "field": "skype",
8158             "description": ""
8159           },
8160           {
8161             "group": "Body",
8162             "type": "String",
8163             "optional": true,
8164             "field": "teams",
8165             "description": ""
8166           },
8167           {
8168             "group": "Body",
8169             "type": "String",
8170             "optional": true,
8171             "field": "viber",
8172             "description": ""
8173           },
8174           {
8175             "group": "Body",
8176             "type": "String",
8177             "optional": true,
8178             "field": "line",
8179             "description": ""
8180           },
8181           {
8182             "group": "Body",
8183             "type": "String",
8184             "optional": true,
8185             "field": "wechat",
8186             "description": ""
8187           },
8188           {
8189             "group": "Body",
8190             "type": "String",
8191             "optional": true,
8192             "field": "telegram",
8193             "description": ""
8194           },
8195           {
8196             "group": "Body",
8197             "type": "Integer",
8198             "optional": true,
8199             "field": "UserId",
8200             "description": ""
8201           },
8202           {
8203             "group": "Body",
8204             "type": "Integer",
8205             "optional": true,
8206             "field": "priority",
8207             "description": ""
8208           },
8209           {
8210             "group": "Body",
8211             "type": "String",
8212             "optional": true,
8213             "field": "scheduledat",
8214             "description": ""
8215           }
8216         ]
8217       }
8218     },
8219     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8220     "version": "0.0.0",
8221     "filename": "server/api/cmList/index.js",
8222     "groupTitle": "Cm_Lists"
8223   },
8224   {
8225     "type": "post",
8226     "url": "/api/cm/lists/{id}/fields",
8227     "title": "Creates a new custom field",
8228     "examples": [
8229       {
8230         "title": "Example usage:",
8231         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8232         "type": "json"
8233       }
8234     ],
8235     "name": "addCustomField",
8236     "group": "Cm_Lists",
8237     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8238     "version": "0.0.0",
8239     "filename": "server/api/cmList/index.js",
8240     "groupTitle": "Cm_Lists"
8241   },
8242   {
8243     "type": "post",
8244     "url": "/api/cm/lists/{id}/dispositions",
8245     "title": "Creates new disposition",
8246     "examples": [
8247       {
8248         "title": "Example usage:",
8249         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8250         "type": "json"
8251       }
8252     ],
8253     "name": "addDisposition",
8254     "group": "Cm_Lists",
8255     "parameter": {
8256       "fields": {
8257         "Body": [
8258           {
8259             "group": "Body",
8260             "type": "String",
8261             "optional": false,
8262             "field": "name",
8263             "description": ""
8264           },
8265           {
8266             "group": "Body",
8267             "type": "String",
8268             "allowedValues": [
8269               "\"first\"",
8270               "\"second\"",
8271               "\"third\""
8272             ],
8273             "optional": false,
8274             "field": "level",
8275             "description": ""
8276           },
8277           {
8278             "group": "Body",
8279             "type": "String",
8280             "optional": true,
8281             "field": "description",
8282             "description": ""
8283           }
8284         ]
8285       }
8286     },
8287     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8288     "version": "0.0.0",
8289     "filename": "server/api/cmList/index.js",
8290     "groupTitle": "Cm_Lists"
8291   },
8292   {
8293     "type": "get",
8294     "url": "/api/cm/lists/{id}/contacts",
8295     "title": "Gets List Contacts",
8296     "examples": [
8297       {
8298         "title": "Example usage:",
8299         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8300         "type": "json"
8301       }
8302     ],
8303     "name": "getContacts",
8304     "group": "Cm_Lists",
8305     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8306     "version": "0.0.0",
8307     "filename": "server/api/cmList/index.js",
8308     "groupTitle": "Cm_Lists"
8309   },
8310   {
8311     "type": "get",
8312     "url": "/api/cm/lists/{id}/fields",
8313     "title": "Gets Custom Fields",
8314     "examples": [
8315       {
8316         "title": "Example usage:",
8317         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8318         "type": "json"
8319       }
8320     ],
8321     "name": "getCustomFields",
8322     "group": "Cm_Lists",
8323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8324     "version": "0.0.0",
8325     "filename": "server/api/cmList/index.js",
8326     "groupTitle": "Cm_Lists"
8327   },
8328   {
8329     "type": "get",
8330     "url": "/api/cm/lists/{id}/dispositions",
8331     "title": "Gets list dispositions",
8332     "examples": [
8333       {
8334         "title": "Example usage:",
8335         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8336         "type": "json"
8337       }
8338     ],
8339     "name": "getDispositions",
8340     "group": "Cm_Lists",
8341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8342     "version": "0.0.0",
8343     "filename": "server/api/cmList/index.js",
8344     "groupTitle": "Cm_Lists"
8345   },
8346   {
8347     "type": "get",
8348     "url": "/api/cm/lists/global_fields",
8349     "title": "Gets GLOBAL Custom Fields",
8350     "examples": [
8351       {
8352         "title": "Example usage:",
8353         "content": "curl https://{domain}/api/cm/lists/global_fields -v -u {name}:{password} -X GET",
8354         "type": "json"
8355       }
8356     ],
8357     "name": "getGlobalCustomFields",
8358     "group": "Cm_Lists",
8359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8360     "version": "0.0.0",
8361     "filename": "server/api/cmList/index.js",
8362     "groupTitle": "Cm_Lists"
8363   },
8364   {
8365     "type": "get",
8366     "url": "/api/cm/lists/{id}/contacts/csv",
8367     "title": "Gets CSV List Contacts",
8368     "examples": [
8369       {
8370         "title": "Example usage:",
8371         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8372         "type": "json"
8373       }
8374     ],
8375     "name": "grunt",
8376     "group": "Cm_Lists",
8377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8378     "version": "0.0.0",
8379     "filename": "server/api/cmList/index.js",
8380     "groupTitle": "Cm_Lists"
8381   },
8382   {
8383     "type": "put",
8384     "url": "/api/cm/lists/{id}",
8385     "title": "Update an existing List",
8386     "examples": [
8387       {
8388         "title": "Example usage:",
8389         "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",
8390         "type": "json"
8391       }
8392     ],
8393     "name": "updateLists",
8394     "group": "Cm_Lists",
8395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8396     "version": "0.0.0",
8397     "filename": "server/api/cmList/index.js",
8398     "groupTitle": "Cm_Lists"
8399   },
8400   {
8401     "type": "post",
8402     "url": "/api/cm/contacts/upload/:id",
8403     "title": "Import new contacts by csv",
8404     "examples": [
8405       {
8406         "title": "Example usage:",
8407         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8408         "type": "json"
8409       }
8410     ],
8411     "name": "import",
8412     "group": "Cm_contacts",
8413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8414     "version": "0.0.0",
8415     "filename": "server/api/cmContact/index.js",
8416     "groupTitle": "Cm_contacts"
8417   },
8418   {
8419     "type": "post",
8420     "url": "/api/cm/contacts/uploadUpdates/:id",
8421     "title": "Import existing contacts by csv",
8422     "examples": [
8423       {
8424         "title": "Example usage:",
8425         "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
8426         "type": "json"
8427       }
8428     ],
8429     "name": "importUpdates",
8430     "group": "Cm_contacts",
8431     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8432     "version": "0.0.0",
8433     "filename": "server/api/cmContact/index.js",
8434     "groupTitle": "Cm_contacts"
8435   },
8436   {
8437     "type": "post",
8438     "url": "/api/cm/contacts/upload",
8439     "title": "Upload csv",
8440     "examples": [
8441       {
8442         "title": "Example usage:",
8443         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8444         "type": "json"
8445       }
8446     ],
8447     "name": "upload",
8448     "group": "Cm_contacts",
8449     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8450     "version": "0.0.0",
8451     "filename": "server/api/cmContact/index.js",
8452     "groupTitle": "Cm_contacts"
8453   },
8454   {
8455     "type": "post",
8456     "url": "/api/cm/contacts/csv",
8457     "title": "Create new contacts by csv",
8458     "examples": [
8459       {
8460         "title": "Example usage:",
8461         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8462         "type": "json"
8463       }
8464     ],
8465     "name": "uploadCsv",
8466     "group": "Cm_contacts",
8467     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8468     "version": "0.0.0",
8469     "filename": "server/api/cmContact/index.js",
8470     "groupTitle": "Cm_contacts"
8471   },
8472   {
8473     "type": "delete",
8474     "url": "/api/conditions/{id}",
8475     "title": "Deletes a Condition",
8476     "examples": [
8477       {
8478         "title": "Example usage:",
8479         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8480         "type": "json"
8481       }
8482     ],
8483     "name": "DeleteConditions",
8484     "group": "Conditions",
8485     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8486     "version": "0.0.0",
8487     "filename": "server/api/condition/index.js",
8488     "groupTitle": "Conditions"
8489   },
8490   {
8491     "type": "put",
8492     "url": "/api/conditions/{id}",
8493     "title": "Update an existing Condition",
8494     "examples": [
8495       {
8496         "title": "Example usage:",
8497         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8498         "type": "json"
8499       }
8500     ],
8501     "name": "updateConditions",
8502     "group": "Conditions",
8503     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8504     "version": "0.0.0",
8505     "filename": "server/api/condition/index.js",
8506     "groupTitle": "Conditions"
8507   },
8508   {
8509     "type": "post",
8510     "url": "/api/contact_item_types",
8511     "title": "Creates a new ContactItemType",
8512     "examples": [
8513       {
8514         "title": "Example usage:",
8515         "content": "curl https://{domain}/api/contact_item_types -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8516         "type": "json"
8517       }
8518     ],
8519     "name": "CreateContactItemTypes",
8520     "group": "ContactItemType",
8521     "parameter": {
8522       "fields": {
8523         "Body": [
8524           {
8525             "group": "Body",
8526             "type": "String",
8527             "optional": false,
8528             "field": "name",
8529             "description": ""
8530           },
8531           {
8532             "group": "Body",
8533             "type": "Integer",
8534             "optional": true,
8535             "field": "OrderBy",
8536             "description": ""
8537           },
8538           {
8539             "group": "Body",
8540             "type": "String",
8541             "optional": true,
8542             "field": "rgbBackgroundColor",
8543             "description": ""
8544           }
8545         ]
8546       }
8547     },
8548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8549     "version": "0.0.0",
8550     "filename": "server/api/contactItemType/index.js",
8551     "groupTitle": "ContactItemType"
8552   },
8553   {
8554     "type": "delete",
8555     "url": "/api/contact_item_types/{id}",
8556     "title": "Deletes a ContactItemType",
8557     "examples": [
8558       {
8559         "title": "Example usage:",
8560         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8561         "type": "json"
8562       }
8563     ],
8564     "name": "DeleteContactItemTypes",
8565     "group": "ContactItemType",
8566     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8567     "version": "0.0.0",
8568     "filename": "server/api/contactItemType/index.js",
8569     "groupTitle": "ContactItemType"
8570   },
8571   {
8572     "type": "get",
8573     "url": "/api/contact_item_types",
8574     "title": "Gets a list of ContactItemTypes",
8575     "examples": [
8576       {
8577         "title": "Example usage:",
8578         "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8579         "type": "json"
8580       }
8581     ],
8582     "name": "GetContactItemTypes",
8583     "group": "ContactItemType",
8584     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/contact_item_types?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/contact_item_types?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/contact_item_types?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/contact_item_types?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/contact_item_types?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8585     "version": "0.0.0",
8586     "filename": "server/api/contactItemType/index.js",
8587     "groupTitle": "ContactItemType"
8588   },
8589   {
8590     "type": "get",
8591     "url": "/api/contact_item_types/{id}",
8592     "title": "Gets a single ContactItemType",
8593     "examples": [
8594       {
8595         "title": "Example usage:",
8596         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8597         "type": "json"
8598       }
8599     ],
8600     "name": "ShowContactItemTypes",
8601     "group": "ContactItemType",
8602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8603     "version": "0.0.0",
8604     "filename": "server/api/contactItemType/index.js",
8605     "groupTitle": "ContactItemType"
8606   },
8607   {
8608     "type": "put",
8609     "url": "/api/contact_item_types/{id}",
8610     "title": "Update an existing ContactItemType",
8611     "examples": [
8612       {
8613         "title": "Example usage:",
8614         "content": "curl https://{domain}/api/contact_item_types/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8615         "type": "json"
8616       }
8617     ],
8618     "name": "updateContactItemTypes",
8619     "group": "ContactItemType",
8620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8621     "version": "0.0.0",
8622     "filename": "server/api/contactItemType/index.js",
8623     "groupTitle": "ContactItemType"
8624   },
8625   {
8626     "type": "post",
8627     "url": "/api/cm/custom_field",
8628     "title": "Create a new custom field",
8629     "examples": [
8630       {
8631         "title": "Example usage:",
8632         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8633         "type": "json"
8634       }
8635     ],
8636     "name": "CreateCustomField",
8637     "group": "Custom_Fields",
8638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8639     "version": "0.0.0",
8640     "filename": "server/api/cmCustomField/index.js",
8641     "groupTitle": "Custom_Fields"
8642   },
8643   {
8644     "type": "post",
8645     "url": "/api/dashboards/items",
8646     "title": "Create dasboard item",
8647     "examples": [
8648       {
8649         "title": "Example usage:",
8650         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8651         "type": "json"
8652       }
8653     ],
8654     "name": "Create",
8655     "group": "Dashboard_Items",
8656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8657     "version": "0.0.0",
8658     "filename": "server/api/dashboardItem/index.js",
8659     "groupTitle": "Dashboard_Items"
8660   },
8661   {
8662     "type": "delete",
8663     "url": "/api/dashboards/items/{id}",
8664     "title": "Deletes a Dashboard Item",
8665     "examples": [
8666       {
8667         "title": "Example usage:",
8668         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8669         "type": "json"
8670       }
8671     ],
8672     "name": "DeleteDashboard_Items",
8673     "group": "Dashboard_Items",
8674     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8675     "version": "0.0.0",
8676     "filename": "server/api/dashboardItem/index.js",
8677     "groupTitle": "Dashboard_Items"
8678   },
8679   {
8680     "type": "get",
8681     "url": "/api/dashboards/items/{id}",
8682     "title": "Gets a single Dashboard Item",
8683     "examples": [
8684       {
8685         "title": "Example usage:",
8686         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8687         "type": "json"
8688       }
8689     ],
8690     "name": "ShowDashboard_Items",
8691     "group": "Dashboard_Items",
8692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8693     "version": "0.0.0",
8694     "filename": "server/api/dashboardItem/index.js",
8695     "groupTitle": "Dashboard_Items"
8696   },
8697   {
8698     "type": "put",
8699     "url": "/api/dashboards/items/{id}",
8700     "title": "Update an existing item",
8701     "examples": [
8702       {
8703         "title": "Example usage:",
8704         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8705         "type": "json"
8706       }
8707     ],
8708     "name": "Update",
8709     "group": "Dashboard_Items",
8710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8711     "version": "0.0.0",
8712     "filename": "server/api/dashboardItem/index.js",
8713     "groupTitle": "Dashboard_Items"
8714   },
8715   {
8716     "type": "post",
8717     "url": "/api/dashboards/clone",
8718     "title": "Clone an existing Dashboard",
8719     "examples": [
8720       {
8721         "title": "Example usage:",
8722         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8723         "type": "json"
8724       }
8725     ],
8726     "name": "CloneDashboards",
8727     "group": "Dashboards",
8728     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8729     "version": "0.0.0",
8730     "filename": "server/api/dashboard/index.js",
8731     "groupTitle": "Dashboards"
8732   },
8733   {
8734     "type": "post",
8735     "url": "/api/dashboards",
8736     "title": "Creates a new Dashboard",
8737     "examples": [
8738       {
8739         "title": "Example usage:",
8740         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8741         "type": "json"
8742       }
8743     ],
8744     "name": "CreateDashboards",
8745     "group": "Dashboards",
8746     "parameter": {
8747       "fields": {
8748         "Body": [
8749           {
8750             "group": "Body",
8751             "type": "String",
8752             "optional": false,
8753             "field": "name",
8754             "description": ""
8755           },
8756           {
8757             "group": "Body",
8758             "type": "String",
8759             "optional": true,
8760             "field": "description",
8761             "description": ""
8762           }
8763         ]
8764       }
8765     },
8766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8767     "version": "0.0.0",
8768     "filename": "server/api/dashboard/index.js",
8769     "groupTitle": "Dashboards"
8770   },
8771   {
8772     "type": "delete",
8773     "url": "/api/dashboards/{id}",
8774     "title": "Deletes a Dashboard",
8775     "examples": [
8776       {
8777         "title": "Example usage:",
8778         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8779         "type": "json"
8780       }
8781     ],
8782     "name": "DeleteDashboards",
8783     "group": "Dashboards",
8784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8785     "version": "0.0.0",
8786     "filename": "server/api/dashboard/index.js",
8787     "groupTitle": "Dashboards"
8788   },
8789   {
8790     "type": "get",
8791     "url": "/api/dashboards",
8792     "title": "Gets a list of Dashboards",
8793     "examples": [
8794       {
8795         "title": "Example usage:",
8796         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8797         "type": "json"
8798       }
8799     ],
8800     "name": "GetDashboards",
8801     "group": "Dashboards",
8802     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8803     "version": "0.0.0",
8804     "filename": "server/api/dashboard/index.js",
8805     "groupTitle": "Dashboards"
8806   },
8807   {
8808     "type": "get",
8809     "url": "/api/dashboards/{id}",
8810     "title": "Gets a single Dashboard",
8811     "examples": [
8812       {
8813         "title": "Example usage:",
8814         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8815         "type": "json"
8816       }
8817     ],
8818     "name": "ShowDashboards",
8819     "group": "Dashboards",
8820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8821     "version": "0.0.0",
8822     "filename": "server/api/dashboard/index.js",
8823     "groupTitle": "Dashboards"
8824   },
8825   {
8826     "type": "post",
8827     "url": "/api/dashboards/{id}/items",
8828     "title": "Creates new item",
8829     "examples": [
8830       {
8831         "title": "Example usage:",
8832         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8833         "type": "json"
8834       }
8835     ],
8836     "name": "addItem",
8837     "group": "Dashboards",
8838     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8839     "version": "0.0.0",
8840     "filename": "server/api/dashboard/index.js",
8841     "groupTitle": "Dashboards"
8842   },
8843   {
8844     "type": "get",
8845     "url": "/api/dashboards/{id}/items",
8846     "title": "Gets items",
8847     "examples": [
8848       {
8849         "title": "Example usage:",
8850         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8851         "type": "json"
8852       }
8853     ],
8854     "name": "getItems",
8855     "group": "Dashboards",
8856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8857     "version": "0.0.0",
8858     "filename": "server/api/dashboard/index.js",
8859     "groupTitle": "Dashboards"
8860   },
8861   {
8862     "type": "put",
8863     "url": "/api/dashboards/{id}",
8864     "title": "Update an existing Dashboard",
8865     "examples": [
8866       {
8867         "title": "Example usage:",
8868         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8869         "type": "json"
8870       }
8871     ],
8872     "name": "updateDashboards",
8873     "group": "Dashboards",
8874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8875     "version": "0.0.0",
8876     "filename": "server/api/dashboard/index.js",
8877     "groupTitle": "Dashboards"
8878   },
8879   {
8880     "type": "post",
8881     "url": "/api/integrations/desk/accounts",
8882     "title": "Creates a new Desk Account",
8883     "examples": [
8884       {
8885         "title": "Example usage:",
8886         "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",
8887         "type": "json"
8888       }
8889     ],
8890     "name": "CreateDesk_Accounts",
8891     "group": "Desk_Accounts",
8892     "parameter": {
8893       "fields": {
8894         "Body": [
8895           {
8896             "group": "Body",
8897             "type": "String",
8898             "optional": true,
8899             "field": "name",
8900             "description": ""
8901           },
8902           {
8903             "group": "Body",
8904             "type": "String",
8905             "optional": true,
8906             "field": "description",
8907             "description": ""
8908           },
8909           {
8910             "group": "Body",
8911             "type": "String",
8912             "optional": true,
8913             "field": "username",
8914             "description": ""
8915           },
8916           {
8917             "group": "Body",
8918             "type": "String",
8919             "optional": true,
8920             "field": "remoteUri",
8921             "description": ""
8922           },
8923           {
8924             "group": "Body",
8925             "type": "String",
8926             "allowedValues": [
8927               "\"basic\""
8928             ],
8929             "optional": true,
8930             "field": "authType",
8931             "description": ""
8932           },
8933           {
8934             "group": "Body",
8935             "type": "String",
8936             "optional": true,
8937             "field": "password",
8938             "description": ""
8939           },
8940           {
8941             "group": "Body",
8942             "type": "String",
8943             "optional": true,
8944             "field": "consumerKey",
8945             "description": ""
8946           },
8947           {
8948             "group": "Body",
8949             "type": "String",
8950             "optional": true,
8951             "field": "consumerSecret",
8952             "description": ""
8953           },
8954           {
8955             "group": "Body",
8956             "type": "String",
8957             "optional": true,
8958             "field": "token",
8959             "description": ""
8960           },
8961           {
8962             "group": "Body",
8963             "type": "String",
8964             "optional": true,
8965             "field": "tokenSecret",
8966             "description": ""
8967           },
8968           {
8969             "group": "Body",
8970             "type": "String",
8971             "optional": false,
8972             "field": "serverUrl",
8973             "description": ""
8974           },
8975           {
8976             "group": "Body",
8977             "type": "String",
8978             "allowedValues": [
8979               "\"integrationTab\"",
8980               "\"newTab\""
8981             ],
8982             "optional": true,
8983             "field": "type",
8984             "description": ""
8985           }
8986         ]
8987       }
8988     },
8989     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8990     "version": "0.0.0",
8991     "filename": "server/api/intDeskAccount/index.js",
8992     "groupTitle": "Desk_Accounts"
8993   },
8994   {
8995     "type": "delete",
8996     "url": "/api/integrations/desk/accounts/{id}",
8997     "title": "Deletes a Desk Account",
8998     "examples": [
8999       {
9000         "title": "Example usage:",
9001         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
9002         "type": "json"
9003       }
9004     ],
9005     "name": "DeleteDesk_Accounts",
9006     "group": "Desk_Accounts",
9007     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9008     "version": "0.0.0",
9009     "filename": "server/api/intDeskAccount/index.js",
9010     "groupTitle": "Desk_Accounts"
9011   },
9012   {
9013     "type": "get",
9014     "url": "/api/integrations/desk/accounts",
9015     "title": "Gets a list of Desk Accounts",
9016     "examples": [
9017       {
9018         "title": "Example usage:",
9019         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
9020         "type": "json"
9021       }
9022     ],
9023     "name": "GetDesk_Accounts",
9024     "group": "Desk_Accounts",
9025     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9026     "version": "0.0.0",
9027     "filename": "server/api/intDeskAccount/index.js",
9028     "groupTitle": "Desk_Accounts"
9029   },
9030   {
9031     "type": "get",
9032     "url": "/api/integrations/desk/accounts/{id}",
9033     "title": "Gets a single Desk Account",
9034     "examples": [
9035       {
9036         "title": "Example usage:",
9037         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
9038         "type": "json"
9039       }
9040     ],
9041     "name": "ShowDesk_Accounts",
9042     "group": "Desk_Accounts",
9043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9044     "version": "0.0.0",
9045     "filename": "server/api/intDeskAccount/index.js",
9046     "groupTitle": "Desk_Accounts"
9047   },
9048   {
9049     "type": "post",
9050     "url": "/api/integrations/desk/accounts/{id}/configurations",
9051     "title": "Creates new configuration",
9052     "examples": [
9053       {
9054         "title": "Example usage:",
9055         "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",
9056         "type": "json"
9057       }
9058     ],
9059     "name": "addConfiguration",
9060     "group": "Desk_Accounts",
9061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9062     "version": "0.0.0",
9063     "filename": "server/api/intDeskAccount/index.js",
9064     "groupTitle": "Desk_Accounts"
9065   },
9066   {
9067     "type": "get",
9068     "url": "/api/integrations/desk/accounts/{id}/configurations",
9069     "title": "Gets account configurations",
9070     "examples": [
9071       {
9072         "title": "Example usage:",
9073         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9074         "type": "json"
9075       }
9076     ],
9077     "name": "getConfigurations",
9078     "group": "Desk_Accounts",
9079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9080     "version": "0.0.0",
9081     "filename": "server/api/intDeskAccount/index.js",
9082     "groupTitle": "Desk_Accounts"
9083   },
9084   {
9085     "type": "get",
9086     "url": "/api/integrations/desk/accounts/{id}/fields",
9087     "title": "Gets account fields",
9088     "examples": [
9089       {
9090         "title": "Example usage:",
9091         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
9092         "type": "json"
9093       }
9094     ],
9095     "name": "getFields",
9096     "group": "Desk_Accounts",
9097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9098     "version": "0.0.0",
9099     "filename": "server/api/intDeskAccount/index.js",
9100     "groupTitle": "Desk_Accounts"
9101   },
9102   {
9103     "type": "put",
9104     "url": "/api/integrations/desk/accounts/{id}",
9105     "title": "Update an existing Desk Account",
9106     "examples": [
9107       {
9108         "title": "Example usage:",
9109         "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",
9110         "type": "json"
9111       }
9112     ],
9113     "name": "updateDesk_Accounts",
9114     "group": "Desk_Accounts",
9115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9116     "version": "0.0.0",
9117     "filename": "server/api/intDeskAccount/index.js",
9118     "groupTitle": "Desk_Accounts"
9119   },
9120   {
9121     "type": "post",
9122     "url": "/api/integrations/desk/configurations",
9123     "title": "Creates a new Desk Configuration",
9124     "examples": [
9125       {
9126         "title": "Example usage:",
9127         "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",
9128         "type": "json"
9129       }
9130     ],
9131     "name": "CreateDesk_Configurations",
9132     "group": "Desk_Configurations",
9133     "parameter": {
9134       "fields": {
9135         "Body": [
9136           {
9137             "group": "Body",
9138             "type": "String",
9139             "optional": true,
9140             "field": "name",
9141             "description": ""
9142           },
9143           {
9144             "group": "Body",
9145             "type": "String",
9146             "optional": true,
9147             "field": "description",
9148             "description": ""
9149           }
9150         ]
9151       }
9152     },
9153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9154     "version": "0.0.0",
9155     "filename": "server/api/intDeskConfiguration/index.js",
9156     "groupTitle": "Desk_Configurations"
9157   },
9158   {
9159     "type": "delete",
9160     "url": "/api/integrations/desk/configurations/{id}",
9161     "title": "Deletes a Desk Configuration",
9162     "examples": [
9163       {
9164         "title": "Example usage:",
9165         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
9166         "type": "json"
9167       }
9168     ],
9169     "name": "DeleteDesk_Configurations",
9170     "group": "Desk_Configurations",
9171     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9172     "version": "0.0.0",
9173     "filename": "server/api/intDeskConfiguration/index.js",
9174     "groupTitle": "Desk_Configurations"
9175   },
9176   {
9177     "type": "get",
9178     "url": "/api/integrations/desk/configurations",
9179     "title": "Gets a list of Desk Configurations",
9180     "examples": [
9181       {
9182         "title": "Example usage:",
9183         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
9184         "type": "json"
9185       }
9186     ],
9187     "name": "GetDesk_Configurations",
9188     "group": "Desk_Configurations",
9189     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9190     "version": "0.0.0",
9191     "filename": "server/api/intDeskConfiguration/index.js",
9192     "groupTitle": "Desk_Configurations"
9193   },
9194   {
9195     "type": "get",
9196     "url": "/api/integrations/desk/configurations/{id}",
9197     "title": "Gets a single Desk Configuration",
9198     "examples": [
9199       {
9200         "title": "Example usage:",
9201         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
9202         "type": "json"
9203       }
9204     ],
9205     "name": "ShowDesk_Configurations",
9206     "group": "Desk_Configurations",
9207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9208     "version": "0.0.0",
9209     "filename": "server/api/intDeskConfiguration/index.js",
9210     "groupTitle": "Desk_Configurations"
9211   },
9212   {
9213     "type": "get",
9214     "url": "/api/integrations/desk/configurations/{id}/descriptions",
9215     "title": "Gets configurations descriptions",
9216     "examples": [
9217       {
9218         "title": "Example usage:",
9219         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9220         "type": "json"
9221       }
9222     ],
9223     "name": "getDescriptions",
9224     "group": "Desk_Configurations",
9225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9226     "version": "0.0.0",
9227     "filename": "server/api/intDeskConfiguration/index.js",
9228     "groupTitle": "Desk_Configurations"
9229   },
9230   {
9231     "type": "get",
9232     "url": "/api/integrations/desk/configurations/{id}/fields",
9233     "title": "Gets configurations fields",
9234     "examples": [
9235       {
9236         "title": "Example usage:",
9237         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9238         "type": "json"
9239       }
9240     ],
9241     "name": "getFields",
9242     "group": "Desk_Configurations",
9243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9244     "version": "0.0.0",
9245     "filename": "server/api/intDeskConfiguration/index.js",
9246     "groupTitle": "Desk_Configurations"
9247   },
9248   {
9249     "type": "get",
9250     "url": "/api/integrations/desk/configurations/{id}/subjects",
9251     "title": "Gets configurations subjects",
9252     "examples": [
9253       {
9254         "title": "Example usage:",
9255         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9256         "type": "json"
9257       }
9258     ],
9259     "name": "getSubjects",
9260     "group": "Desk_Configurations",
9261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9262     "version": "0.0.0",
9263     "filename": "server/api/intDeskConfiguration/index.js",
9264     "groupTitle": "Desk_Configurations"
9265   },
9266   {
9267     "type": "get",
9268     "url": "/api/integrations/desk/configurations/{id}/tags",
9269     "title": "Gets configurations tags",
9270     "examples": [
9271       {
9272         "title": "Example usage:",
9273         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9274         "type": "json"
9275       }
9276     ],
9277     "name": "getTags",
9278     "group": "Desk_Configurations",
9279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9280     "version": "0.0.0",
9281     "filename": "server/api/intDeskConfiguration/index.js",
9282     "groupTitle": "Desk_Configurations"
9283   },
9284   {
9285     "type": "post",
9286     "url": "/api/integrations/desk/configurations/{id}/tags",
9287     "title": "Sets new tags",
9288     "examples": [
9289       {
9290         "title": "Example usage:",
9291         "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",
9292         "type": "json"
9293       }
9294     ],
9295     "name": "setTags",
9296     "group": "Desk_Configurations",
9297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9298     "version": "0.0.0",
9299     "filename": "server/api/intDeskConfiguration/index.js",
9300     "groupTitle": "Desk_Configurations"
9301   },
9302   {
9303     "type": "put",
9304     "url": "/api/integrations/desk/configurations/{id}",
9305     "title": "Update an existing Desk Configuration",
9306     "examples": [
9307       {
9308         "title": "Example usage:",
9309         "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",
9310         "type": "json"
9311       }
9312     ],
9313     "name": "updateDesk_Configurations",
9314     "group": "Desk_Configurations",
9315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9316     "version": "0.0.0",
9317     "filename": "server/api/intDeskConfiguration/index.js",
9318     "groupTitle": "Desk_Configurations"
9319   },
9320   {
9321     "type": "post",
9322     "url": "/api/integrations/desk/fields",
9323     "title": "Creates a new Desk Field",
9324     "examples": [
9325       {
9326         "title": "Example usage:",
9327         "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",
9328         "type": "json"
9329       }
9330     ],
9331     "name": "CreateDesk_Fields",
9332     "group": "Desk_Fields",
9333     "parameter": {
9334       "fields": {
9335         "Body": [
9336           {
9337             "group": "Body",
9338             "type": "String",
9339             "allowedValues": [
9340               "\"string\"",
9341               "\"variable\"",
9342               "\"customVariable\"",
9343               "\"keyValue\"",
9344               "\"picklist\""
9345             ],
9346             "optional": true,
9347             "field": "type",
9348             "description": ""
9349           },
9350           {
9351             "group": "Body",
9352             "type": "String",
9353             "optional": true,
9354             "field": "content",
9355             "description": ""
9356           },
9357           {
9358             "group": "Body",
9359             "type": "String",
9360             "optional": true,
9361             "field": "key",
9362             "description": ""
9363           },
9364           {
9365             "group": "Body",
9366             "type": "String",
9367             "allowedValues": [
9368               "\"string\"",
9369               "\"variable\"",
9370               "\"customVariable\""
9371             ],
9372             "optional": true,
9373             "field": "keyType",
9374             "description": ""
9375           },
9376           {
9377             "group": "Body",
9378             "type": "String",
9379             "optional": true,
9380             "field": "keyContent",
9381             "description": ""
9382           },
9383           {
9384             "group": "Body",
9385             "type": "String",
9386             "optional": true,
9387             "field": "idField",
9388             "description": ""
9389           },
9390           {
9391             "group": "Body",
9392             "type": "String",
9393             "optional": true,
9394             "field": "nameField",
9395             "description": ""
9396           },
9397           {
9398             "group": "Body",
9399             "type": "Boolean",
9400             "optional": true,
9401             "field": "customField",
9402             "description": ""
9403           },
9404           {
9405             "group": "Body",
9406             "type": "String",
9407             "optional": true,
9408             "field": "variableName",
9409             "description": ""
9410           }
9411         ]
9412       }
9413     },
9414     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9415     "version": "0.0.0",
9416     "filename": "server/api/intDeskField/index.js",
9417     "groupTitle": "Desk_Fields"
9418   },
9419   {
9420     "type": "delete",
9421     "url": "/api/integrations/desk/fields/{id}",
9422     "title": "Deletes a Desk Field",
9423     "examples": [
9424       {
9425         "title": "Example usage:",
9426         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9427         "type": "json"
9428       }
9429     ],
9430     "name": "DeleteDesk_Fields",
9431     "group": "Desk_Fields",
9432     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9433     "version": "0.0.0",
9434     "filename": "server/api/intDeskField/index.js",
9435     "groupTitle": "Desk_Fields"
9436   },
9437   {
9438     "type": "get",
9439     "url": "/api/integrations/desk/fields",
9440     "title": "Gets a list of Desk Fields",
9441     "examples": [
9442       {
9443         "title": "Example usage:",
9444         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9445         "type": "json"
9446       }
9447     ],
9448     "name": "GetDesk_Fields",
9449     "group": "Desk_Fields",
9450     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9451     "version": "0.0.0",
9452     "filename": "server/api/intDeskField/index.js",
9453     "groupTitle": "Desk_Fields"
9454   },
9455   {
9456     "type": "get",
9457     "url": "/api/integrations/desk/fields/{id}",
9458     "title": "Gets a single Desk Field",
9459     "examples": [
9460       {
9461         "title": "Example usage:",
9462         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9463         "type": "json"
9464       }
9465     ],
9466     "name": "ShowDesk_Fields",
9467     "group": "Desk_Fields",
9468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9469     "version": "0.0.0",
9470     "filename": "server/api/intDeskField/index.js",
9471     "groupTitle": "Desk_Fields"
9472   },
9473   {
9474     "type": "put",
9475     "url": "/api/integrations/desk/fields/{id}",
9476     "title": "Update an existing Desk Field",
9477     "examples": [
9478       {
9479         "title": "Example usage:",
9480         "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",
9481         "type": "json"
9482       }
9483     ],
9484     "name": "updateDesk_Fields",
9485     "group": "Desk_Fields",
9486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9487     "version": "0.0.0",
9488     "filename": "server/api/intDeskField/index.js",
9489     "groupTitle": "Desk_Fields"
9490   },
9491   {
9492     "type": "post",
9493     "url": "/api/dispositions",
9494     "title": "Creates a new Disposition",
9495     "examples": [
9496       {
9497         "title": "Example usage:",
9498         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9499         "type": "json"
9500       }
9501     ],
9502     "name": "CreateDispositions",
9503     "group": "Dispositions",
9504     "parameter": {
9505       "fields": {
9506         "Body": [
9507           {
9508             "group": "Body",
9509             "type": "String",
9510             "optional": false,
9511             "field": "name",
9512             "description": ""
9513           },
9514           {
9515             "group": "Body",
9516             "type": "String",
9517             "allowedValues": [
9518               "\"first\"",
9519               "\"second\"",
9520               "\"third\""
9521             ],
9522             "optional": false,
9523             "field": "level",
9524             "description": ""
9525           },
9526           {
9527             "group": "Body",
9528             "type": "String",
9529             "optional": true,
9530             "field": "description",
9531             "description": ""
9532           }
9533         ]
9534       }
9535     },
9536     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9537     "version": "0.0.0",
9538     "filename": "server/api/disposition/index.js",
9539     "groupTitle": "Dispositions"
9540   },
9541   {
9542     "type": "delete",
9543     "url": "/api/dispositions/{id}",
9544     "title": "Deletes a Disposition",
9545     "examples": [
9546       {
9547         "title": "Example usage:",
9548         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9549         "type": "json"
9550       }
9551     ],
9552     "name": "DeleteDispositions",
9553     "group": "Dispositions",
9554     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9555     "version": "0.0.0",
9556     "filename": "server/api/disposition/index.js",
9557     "groupTitle": "Dispositions"
9558   },
9559   {
9560     "type": "get",
9561     "url": "/api/dispositions",
9562     "title": "Gets a list of Dispositions",
9563     "examples": [
9564       {
9565         "title": "Example usage:",
9566         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9567         "type": "json"
9568       }
9569     ],
9570     "name": "GetDispositions",
9571     "group": "Dispositions",
9572     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9573     "version": "0.0.0",
9574     "filename": "server/api/disposition/index.js",
9575     "groupTitle": "Dispositions"
9576   },
9577   {
9578     "type": "get",
9579     "url": "/api/dispositions/{id}",
9580     "title": "Gets a single Disposition",
9581     "examples": [
9582       {
9583         "title": "Example usage:",
9584         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9585         "type": "json"
9586       }
9587     ],
9588     "name": "ShowDispositions",
9589     "group": "Dispositions",
9590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9591     "version": "0.0.0",
9592     "filename": "server/api/disposition/index.js",
9593     "groupTitle": "Dispositions"
9594   },
9595   {
9596     "type": "put",
9597     "url": "/api/dispositions/{id}",
9598     "title": "Update an existing Disposition",
9599     "examples": [
9600       {
9601         "title": "Example usage:",
9602         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9603         "type": "json"
9604       }
9605     ],
9606     "name": "updateDispositions",
9607     "group": "Dispositions",
9608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9609     "version": "0.0.0",
9610     "filename": "server/api/disposition/index.js",
9611     "groupTitle": "Dispositions"
9612   },
9613   {
9614     "type": "post",
9615     "url": "/api/integrations/dynamics365/accounts",
9616     "title": "Creates a new Dynamics365 Account",
9617     "examples": [
9618       {
9619         "title": "Example usage:",
9620         "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",
9621         "type": "json"
9622       }
9623     ],
9624     "name": "CreateDynamics365_Accounts",
9625     "group": "Dynamics365_Accounts",
9626     "parameter": {
9627       "fields": {
9628         "Body": [
9629           {
9630             "group": "Body",
9631             "type": "String",
9632             "optional": true,
9633             "field": "name",
9634             "description": ""
9635           },
9636           {
9637             "group": "Body",
9638             "type": "String",
9639             "optional": true,
9640             "field": "username",
9641             "description": ""
9642           },
9643           {
9644             "group": "Body",
9645             "type": "String",
9646             "optional": true,
9647             "field": "password",
9648             "description": ""
9649           },
9650           {
9651             "group": "Body",
9652             "type": "String",
9653             "optional": true,
9654             "field": "remoteUri",
9655             "description": ""
9656           },
9657           {
9658             "group": "Body",
9659             "type": "String",
9660             "optional": true,
9661             "field": "tenantId",
9662             "description": ""
9663           },
9664           {
9665             "group": "Body",
9666             "type": "String",
9667             "optional": true,
9668             "field": "clientId",
9669             "description": ""
9670           },
9671           {
9672             "group": "Body",
9673             "type": "String",
9674             "optional": true,
9675             "field": "clientSecret",
9676             "description": ""
9677           },
9678           {
9679             "group": "Body",
9680             "type": "String",
9681             "optional": false,
9682             "field": "serverUrl",
9683             "description": ""
9684           },
9685           {
9686             "group": "Body",
9687             "type": "String",
9688             "optional": true,
9689             "field": "description",
9690             "description": ""
9691           }
9692         ]
9693       }
9694     },
9695     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9696     "version": "0.0.0",
9697     "filename": "server/api/intDynamics365Account/index.js",
9698     "groupTitle": "Dynamics365_Accounts"
9699   },
9700   {
9701     "type": "delete",
9702     "url": "/api/integrations/dynamics365/accounts/{id}",
9703     "title": "Deletes a Dynamics365 Account",
9704     "examples": [
9705       {
9706         "title": "Example usage:",
9707         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9708         "type": "json"
9709       }
9710     ],
9711     "name": "DeleteDynamics365_Accounts",
9712     "group": "Dynamics365_Accounts",
9713     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9714     "version": "0.0.0",
9715     "filename": "server/api/intDynamics365Account/index.js",
9716     "groupTitle": "Dynamics365_Accounts"
9717   },
9718   {
9719     "type": "get",
9720     "url": "/api/integrations/dynamics365/accounts",
9721     "title": "Gets a list of Dynamics365 Accounts",
9722     "examples": [
9723       {
9724         "title": "Example usage:",
9725         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9726         "type": "json"
9727       }
9728     ],
9729     "name": "GetDynamics365_Accounts",
9730     "group": "Dynamics365_Accounts",
9731     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9732     "version": "0.0.0",
9733     "filename": "server/api/intDynamics365Account/index.js",
9734     "groupTitle": "Dynamics365_Accounts"
9735   },
9736   {
9737     "type": "get",
9738     "url": "/api/integrations/dynamics365/accounts/{id}",
9739     "title": "Gets a single Dynamics365 Account",
9740     "examples": [
9741       {
9742         "title": "Example usage:",
9743         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9744         "type": "json"
9745       }
9746     ],
9747     "name": "ShowDynamics365_Accounts",
9748     "group": "Dynamics365_Accounts",
9749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9750     "version": "0.0.0",
9751     "filename": "server/api/intDynamics365Account/index.js",
9752     "groupTitle": "Dynamics365_Accounts"
9753   },
9754   {
9755     "type": "post",
9756     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9757     "title": "Creates new configuration",
9758     "examples": [
9759       {
9760         "title": "Example usage:",
9761         "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",
9762         "type": "json"
9763       }
9764     ],
9765     "name": "addConfiguration",
9766     "group": "Dynamics365_Accounts",
9767     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9768     "version": "0.0.0",
9769     "filename": "server/api/intDynamics365Account/index.js",
9770     "groupTitle": "Dynamics365_Accounts"
9771   },
9772   {
9773     "type": "get",
9774     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9775     "title": "Gets account configurations",
9776     "examples": [
9777       {
9778         "title": "Example usage:",
9779         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9780         "type": "json"
9781       }
9782     ],
9783     "name": "getConfigurations",
9784     "group": "Dynamics365_Accounts",
9785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9786     "version": "0.0.0",
9787     "filename": "server/api/intDynamics365Account/index.js",
9788     "groupTitle": "Dynamics365_Accounts"
9789   },
9790   {
9791     "type": "get",
9792     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9793     "title": "Gets account fields",
9794     "examples": [
9795       {
9796         "title": "Example usage:",
9797         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9798         "type": "json"
9799       }
9800     ],
9801     "name": "getFields",
9802     "group": "Dynamics365_Accounts",
9803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9804     "version": "0.0.0",
9805     "filename": "server/api/intDynamics365Account/index.js",
9806     "groupTitle": "Dynamics365_Accounts"
9807   },
9808   {
9809     "type": "put",
9810     "url": "/api/integrations/dynamics365/accounts/{id}",
9811     "title": "Update an existing Dynamics365 Account",
9812     "examples": [
9813       {
9814         "title": "Example usage:",
9815         "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",
9816         "type": "json"
9817       }
9818     ],
9819     "name": "updateDynamics365_Accounts",
9820     "group": "Dynamics365_Accounts",
9821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9822     "version": "0.0.0",
9823     "filename": "server/api/intDynamics365Account/index.js",
9824     "groupTitle": "Dynamics365_Accounts"
9825   },
9826   {
9827     "type": "post",
9828     "url": "/api/integrations/dynamics365/configurations",
9829     "title": "Creates a new Dynamics365 Configuration",
9830     "examples": [
9831       {
9832         "title": "Example usage:",
9833         "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",
9834         "type": "json"
9835       }
9836     ],
9837     "name": "CreateDynamics365_Configurations",
9838     "group": "Dynamics365_Configurations",
9839     "parameter": {
9840       "fields": {
9841         "Body": [
9842           {
9843             "group": "Body",
9844             "type": "String",
9845             "optional": true,
9846             "field": "name",
9847             "description": ""
9848           },
9849           {
9850             "group": "Body",
9851             "type": "String",
9852             "optional": true,
9853             "field": "description",
9854             "description": ""
9855           },
9856           {
9857             "group": "Body",
9858             "type": "String",
9859             "allowedValues": [
9860               "\"incident\"",
9861               "\"phonecall\""
9862             ],
9863             "optional": true,
9864             "field": "ticketType",
9865             "description": ""
9866           }
9867         ]
9868       }
9869     },
9870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9871     "version": "0.0.0",
9872     "filename": "server/api/intDynamics365Configuration/index.js",
9873     "groupTitle": "Dynamics365_Configurations"
9874   },
9875   {
9876     "type": "delete",
9877     "url": "/api/integrations/dynamics365/configurations/{id}",
9878     "title": "Deletes a Dynamics365 Configuration",
9879     "examples": [
9880       {
9881         "title": "Example usage:",
9882         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9883         "type": "json"
9884       }
9885     ],
9886     "name": "DeleteDynamics365_Configurations",
9887     "group": "Dynamics365_Configurations",
9888     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9889     "version": "0.0.0",
9890     "filename": "server/api/intDynamics365Configuration/index.js",
9891     "groupTitle": "Dynamics365_Configurations"
9892   },
9893   {
9894     "type": "get",
9895     "url": "/api/integrations/dynamics365/configurations",
9896     "title": "Gets a list of Dynamics365 Configurations",
9897     "examples": [
9898       {
9899         "title": "Example usage:",
9900         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9901         "type": "json"
9902       }
9903     ],
9904     "name": "GetDynamics365_Configurations",
9905     "group": "Dynamics365_Configurations",
9906     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9907     "version": "0.0.0",
9908     "filename": "server/api/intDynamics365Configuration/index.js",
9909     "groupTitle": "Dynamics365_Configurations"
9910   },
9911   {
9912     "type": "get",
9913     "url": "/api/integrations/dynamics365/configurations/{id}",
9914     "title": "Gets a single Dynamics365 Configuration",
9915     "examples": [
9916       {
9917         "title": "Example usage:",
9918         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9919         "type": "json"
9920       }
9921     ],
9922     "name": "ShowDynamics365_Configurations",
9923     "group": "Dynamics365_Configurations",
9924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9925     "version": "0.0.0",
9926     "filename": "server/api/intDynamics365Configuration/index.js",
9927     "groupTitle": "Dynamics365_Configurations"
9928   },
9929   {
9930     "type": "get",
9931     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9932     "title": "Gets configurations descriptions",
9933     "examples": [
9934       {
9935         "title": "Example usage:",
9936         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9937         "type": "json"
9938       }
9939     ],
9940     "name": "getDescriptions",
9941     "group": "Dynamics365_Configurations",
9942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9943     "version": "0.0.0",
9944     "filename": "server/api/intDynamics365Configuration/index.js",
9945     "groupTitle": "Dynamics365_Configurations"
9946   },
9947   {
9948     "type": "get",
9949     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9950     "title": "Gets configurations fields",
9951     "examples": [
9952       {
9953         "title": "Example usage:",
9954         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9955         "type": "json"
9956       }
9957     ],
9958     "name": "getFields",
9959     "group": "Dynamics365_Configurations",
9960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9961     "version": "0.0.0",
9962     "filename": "server/api/intDynamics365Configuration/index.js",
9963     "groupTitle": "Dynamics365_Configurations"
9964   },
9965   {
9966     "type": "get",
9967     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9968     "title": "Gets configurations subjects",
9969     "examples": [
9970       {
9971         "title": "Example usage:",
9972         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9973         "type": "json"
9974       }
9975     ],
9976     "name": "getSubjects",
9977     "group": "Dynamics365_Configurations",
9978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9979     "version": "0.0.0",
9980     "filename": "server/api/intDynamics365Configuration/index.js",
9981     "groupTitle": "Dynamics365_Configurations"
9982   },
9983   {
9984     "type": "put",
9985     "url": "/api/integrations/dynamics365/configurations/{id}",
9986     "title": "Update an existing Dynamics365 Configuration",
9987     "examples": [
9988       {
9989         "title": "Example usage:",
9990         "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",
9991         "type": "json"
9992       }
9993     ],
9994     "name": "updateDynamics365_Configurations",
9995     "group": "Dynamics365_Configurations",
9996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9997     "version": "0.0.0",
9998     "filename": "server/api/intDynamics365Configuration/index.js",
9999     "groupTitle": "Dynamics365_Configurations"
10000   },
10001   {
10002     "type": "post",
10003     "url": "/api/integrations/dynamics365/fields",
10004     "title": "Creates a new Dynamics365 Field",
10005     "examples": [
10006       {
10007         "title": "Example usage:",
10008         "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",
10009         "type": "json"
10010       }
10011     ],
10012     "name": "CreateDynamics365_Fields",
10013     "group": "Dynamics365_Fields",
10014     "parameter": {
10015       "fields": {
10016         "Body": [
10017           {
10018             "group": "Body",
10019             "type": "String",
10020             "allowedValues": [
10021               "\"string\"",
10022               "\"variable\"",
10023               "\"customVariable\"",
10024               "\"keyValue\"",
10025               "\"picklist\""
10026             ],
10027             "optional": true,
10028             "field": "type",
10029             "description": ""
10030           },
10031           {
10032             "group": "Body",
10033             "type": "String",
10034             "optional": true,
10035             "field": "content",
10036             "description": ""
10037           },
10038           {
10039             "group": "Body",
10040             "type": "String",
10041             "optional": true,
10042             "field": "key",
10043             "description": ""
10044           },
10045           {
10046             "group": "Body",
10047             "type": "String",
10048             "allowedValues": [
10049               "\"string\"",
10050               "\"variable\"",
10051               "\"customVariable\""
10052             ],
10053             "optional": true,
10054             "field": "keyType",
10055             "description": ""
10056           },
10057           {
10058             "group": "Body",
10059             "type": "String",
10060             "optional": true,
10061             "field": "keyContent",
10062             "description": ""
10063           },
10064           {
10065             "group": "Body",
10066             "type": "String",
10067             "optional": true,
10068             "field": "idField",
10069             "description": ""
10070           },
10071           {
10072             "group": "Body",
10073             "type": "String",
10074             "optional": true,
10075             "field": "nameField",
10076             "description": ""
10077           },
10078           {
10079             "group": "Body",
10080             "type": "Boolean",
10081             "optional": true,
10082             "field": "customField",
10083             "description": ""
10084           },
10085           {
10086             "group": "Body",
10087             "type": "String",
10088             "optional": true,
10089             "field": "variableName",
10090             "description": ""
10091           }
10092         ]
10093       }
10094     },
10095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10096     "version": "0.0.0",
10097     "filename": "server/api/intDynamics365Field/index.js",
10098     "groupTitle": "Dynamics365_Fields"
10099   },
10100   {
10101     "type": "delete",
10102     "url": "/api/integrations/dynamics365/fields/{id}",
10103     "title": "Deletes a Dynamics365 Field",
10104     "examples": [
10105       {
10106         "title": "Example usage:",
10107         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
10108         "type": "json"
10109       }
10110     ],
10111     "name": "DeleteDynamics365_Fields",
10112     "group": "Dynamics365_Fields",
10113     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10114     "version": "0.0.0",
10115     "filename": "server/api/intDynamics365Field/index.js",
10116     "groupTitle": "Dynamics365_Fields"
10117   },
10118   {
10119     "type": "get",
10120     "url": "/api/integrations/dynamics365/fields",
10121     "title": "Gets a list of Dynamics365 Fields",
10122     "examples": [
10123       {
10124         "title": "Example usage:",
10125         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
10126         "type": "json"
10127       }
10128     ],
10129     "name": "GetDynamics365_Fields",
10130     "group": "Dynamics365_Fields",
10131     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10132     "version": "0.0.0",
10133     "filename": "server/api/intDynamics365Field/index.js",
10134     "groupTitle": "Dynamics365_Fields"
10135   },
10136   {
10137     "type": "get",
10138     "url": "/api/integrations/dynamics365/fields/{id}",
10139     "title": "Gets a single Dynamics365 Field",
10140     "examples": [
10141       {
10142         "title": "Example usage:",
10143         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
10144         "type": "json"
10145       }
10146     ],
10147     "name": "ShowDynamics365_Fields",
10148     "group": "Dynamics365_Fields",
10149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10150     "version": "0.0.0",
10151     "filename": "server/api/intDynamics365Field/index.js",
10152     "groupTitle": "Dynamics365_Fields"
10153   },
10154   {
10155     "type": "put",
10156     "url": "/api/integrations/dynamics365/fields/{id}",
10157     "title": "Update an existing Dynamics365 Field",
10158     "examples": [
10159       {
10160         "title": "Example usage:",
10161         "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",
10162         "type": "json"
10163       }
10164     ],
10165     "name": "updateDynamics365_Fields",
10166     "group": "Dynamics365_Fields",
10167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10168     "version": "0.0.0",
10169     "filename": "server/api/intDynamics365Field/index.js",
10170     "groupTitle": "Dynamics365_Fields"
10171   },
10172   {
10173     "type": "post",
10174     "url": "/api/fax/accounts/{id}/users",
10175     "title": "Add agents to a fax account",
10176     "examples": [
10177       {
10178         "title": "Example usage:",
10179         "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",
10180         "type": "json"
10181       }
10182     ],
10183     "name": "AddAgents",
10184     "group": "Fax_Accounts",
10185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10186     "version": "0.0.0",
10187     "filename": "server/api/faxAccount/index.js",
10188     "groupTitle": "Fax_Accounts"
10189   },
10190   {
10191     "type": "post",
10192     "url": "/api/fax/accounts",
10193     "title": "Creates a new Account",
10194     "examples": [
10195       {
10196         "title": "Example usage:",
10197         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10198         "type": "json"
10199       }
10200     ],
10201     "name": "CreateAccounts",
10202     "group": "Fax_Accounts",
10203     "parameter": {
10204       "fields": {
10205         "Body": [
10206           {
10207             "group": "Body",
10208             "type": "String",
10209             "optional": false,
10210             "field": "name",
10211             "description": ""
10212           },
10213           {
10214             "group": "Body",
10215             "type": "String",
10216             "optional": true,
10217             "field": "description",
10218             "description": ""
10219           },
10220           {
10221             "group": "Body",
10222             "type": "String",
10223             "allowedValues": [
10224               "\"yes\"",
10225               "\"no\""
10226             ],
10227             "optional": true,
10228             "field": "ecm",
10229             "description": ""
10230           },
10231           {
10232             "group": "Body",
10233             "type": "String",
10234             "optional": true,
10235             "field": "headerinfo",
10236             "description": ""
10237           },
10238           {
10239             "group": "Body",
10240             "type": "String",
10241             "optional": true,
10242             "field": "localstationid",
10243             "description": ""
10244           },
10245           {
10246             "group": "Body",
10247             "type": "String",
10248             "allowedValues": [
10249               "\"2400\"",
10250               "\"4800\"",
10251               "\"7200\"",
10252               "\"9600\"",
10253               "\"12000\"",
10254               "\"14400\""
10255             ],
10256             "optional": true,
10257             "field": "minrate",
10258             "description": ""
10259           },
10260           {
10261             "group": "Body",
10262             "type": "String",
10263             "allowedValues": [
10264               "\"2400\"",
10265               "\"4800\"",
10266               "\"7200\"",
10267               "\"9600\"",
10268               "\"12000\"",
10269               "\"14400\""
10270             ],
10271             "optional": true,
10272             "field": "maxrate",
10273             "description": ""
10274           },
10275           {
10276             "group": "Body",
10277             "type": "String",
10278             "optional": true,
10279             "field": "modem",
10280             "description": ""
10281           },
10282           {
10283             "group": "Body",
10284             "type": "String",
10285             "optional": true,
10286             "field": "gateway",
10287             "description": ""
10288           },
10289           {
10290             "group": "Body",
10291             "type": "String",
10292             "optional": true,
10293             "field": "faxdetect",
10294             "description": ""
10295           },
10296           {
10297             "group": "Body",
10298             "type": "Integer",
10299             "optional": true,
10300             "field": "t38timeout",
10301             "description": ""
10302           },
10303           {
10304             "group": "Body",
10305             "type": "String",
10306             "allowedValues": [
10307               "\"SIP\"",
10308               "\"IAX\"",
10309               "\"DADHI\"",
10310               "\"KHOMP\""
10311             ],
10312             "optional": true,
10313             "field": "tech",
10314             "description": ""
10315           },
10316           {
10317             "group": "Body",
10318             "type": "String",
10319             "optional": false,
10320             "field": "key",
10321             "description": ""
10322           },
10323           {
10324             "group": "Body",
10325             "type": "Text",
10326             "optional": true,
10327             "field": "notificationTemplate",
10328             "description": ""
10329           },
10330           {
10331             "group": "Body",
10332             "type": "Boolean",
10333             "optional": true,
10334             "field": "notificationSound",
10335             "description": ""
10336           },
10337           {
10338             "group": "Body",
10339             "type": "Boolean",
10340             "optional": true,
10341             "field": "notificationShake",
10342             "description": ""
10343           },
10344           {
10345             "group": "Body",
10346             "type": "Integer",
10347             "optional": true,
10348             "field": "waitForTheAssignedAgent",
10349             "description": ""
10350           },
10351           {
10352             "group": "Body",
10353             "type": "Integer",
10354             "optional": true,
10355             "field": "waitForTheAssignedQueue",
10356             "description": ""
10357           },
10358           {
10359             "group": "Body",
10360             "type": "Boolean",
10361             "optional": true,
10362             "field": "queueTransfer",
10363             "description": ""
10364           },
10365           {
10366             "group": "Body",
10367             "type": "Integer",
10368             "optional": true,
10369             "field": "queueTransferTimeout",
10370             "description": ""
10371           },
10372           {
10373             "group": "Body",
10374             "type": "Boolean",
10375             "optional": true,
10376             "field": "agentTransfer",
10377             "description": ""
10378           },
10379           {
10380             "group": "Body",
10381             "type": "Integer",
10382             "optional": true,
10383             "field": "agentTransferTimeout",
10384             "description": ""
10385           },
10386           {
10387             "group": "Body",
10388             "type": "Integer",
10389             "optional": true,
10390             "field": "mandatoryDispositionPauseId",
10391             "description": "<p>Status to put when mandatory disposition is enabled</p>"
10392           },
10393           {
10394             "group": "Body",
10395             "type": "Boolean",
10396             "optional": true,
10397             "field": "mandatoryDisposition",
10398             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10399           }
10400         ]
10401       }
10402     },
10403     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10404     "version": "0.0.0",
10405     "filename": "server/api/faxAccount/index.js",
10406     "groupTitle": "Fax_Accounts"
10407   },
10408   {
10409     "type": "delete",
10410     "url": "/api/fax/accounts/{id}",
10411     "title": "Deletes a Account",
10412     "examples": [
10413       {
10414         "title": "Example usage:",
10415         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10416         "type": "json"
10417       }
10418     ],
10419     "name": "DeleteAccounts",
10420     "group": "Fax_Accounts",
10421     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10422     "version": "0.0.0",
10423     "filename": "server/api/faxAccount/index.js",
10424     "groupTitle": "Fax_Accounts"
10425   },
10426   {
10427     "type": "get",
10428     "url": "/api/fax/accounts/describe",
10429     "title": "Gets table info about Accounts",
10430     "examples": [
10431       {
10432         "title": "Example usage:",
10433         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10434         "type": "json"
10435       }
10436     ],
10437     "name": "DescribeAccounts",
10438     "group": "Fax_Accounts",
10439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10440     "version": "0.0.0",
10441     "filename": "server/api/faxAccount/index.js",
10442     "groupTitle": "Fax_Accounts"
10443   },
10444   {
10445     "type": "get",
10446     "url": "/api/fax/accounts",
10447     "title": "Gets a list of Accounts",
10448     "examples": [
10449       {
10450         "title": "Example usage:",
10451         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10452         "type": "json"
10453       }
10454     ],
10455     "name": "GetAccounts",
10456     "group": "Fax_Accounts",
10457     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10458     "version": "0.0.0",
10459     "filename": "server/api/faxAccount/index.js",
10460     "groupTitle": "Fax_Accounts"
10461   },
10462   {
10463     "type": "get",
10464     "url": "/api/fax/accounts/{id}/users",
10465     "title": "Gets agents from fax account",
10466     "examples": [
10467       {
10468         "title": "Example usage:",
10469         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10470         "type": "json"
10471       }
10472     ],
10473     "name": "GetAgents",
10474     "group": "Fax_Accounts",
10475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10476     "version": "0.0.0",
10477     "filename": "server/api/faxAccount/index.js",
10478     "groupTitle": "Fax_Accounts"
10479   },
10480   {
10481     "type": "delete",
10482     "url": "/api/fax/accounts/{id}/users",
10483     "title": "Removes agents from a fax account",
10484     "examples": [
10485       {
10486         "title": "Example usage:",
10487         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10488         "type": "json"
10489       }
10490     ],
10491     "name": "RemoveAgents",
10492     "group": "Fax_Accounts",
10493     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10494     "version": "0.0.0",
10495     "filename": "server/api/faxAccount/index.js",
10496     "groupTitle": "Fax_Accounts"
10497   },
10498   {
10499     "type": "delete",
10500     "url": "/api/fax/accounts/{id}/canned_answers",
10501     "title": "Removes canned answers from account",
10502     "examples": [
10503       {
10504         "title": "Example usage:",
10505         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10506         "type": "json"
10507       }
10508     ],
10509     "name": "RemoveAnswers",
10510     "group": "Fax_Accounts",
10511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10512     "version": "0.0.0",
10513     "filename": "server/api/faxAccount/index.js",
10514     "groupTitle": "Fax_Accounts"
10515   },
10516   {
10517     "type": "delete",
10518     "url": "/api/fax/accounts/{id}/dispositions",
10519     "title": "Removes dispositions from account",
10520     "examples": [
10521       {
10522         "title": "Example usage:",
10523         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10524         "type": "json"
10525       }
10526     ],
10527     "name": "RemoveDispositions",
10528     "group": "Fax_Accounts",
10529     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10530     "version": "0.0.0",
10531     "filename": "server/api/faxAccount/index.js",
10532     "groupTitle": "Fax_Accounts"
10533   },
10534   {
10535     "type": "get",
10536     "url": "/api/fax/accounts/{id}",
10537     "title": "Gets a single Account",
10538     "examples": [
10539       {
10540         "title": "Example usage:",
10541         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10542         "type": "json"
10543       }
10544     ],
10545     "name": "ShowAccounts",
10546     "group": "Fax_Accounts",
10547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10548     "version": "0.0.0",
10549     "filename": "server/api/faxAccount/index.js",
10550     "groupTitle": "Fax_Accounts"
10551   },
10552   {
10553     "type": "post",
10554     "url": "/api/fax/accounts/{id}/canned_answers",
10555     "title": "Creates new canned answer",
10556     "examples": [
10557       {
10558         "title": "Example usage:",
10559         "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",
10560         "type": "json"
10561       }
10562     ],
10563     "name": "addAnswer",
10564     "group": "Fax_Accounts",
10565     "parameter": {
10566       "fields": {
10567         "Body": [
10568           {
10569             "group": "Body",
10570             "type": "String",
10571             "optional": false,
10572             "field": "key",
10573             "description": ""
10574           },
10575           {
10576             "group": "Body",
10577             "type": "Text",
10578             "optional": false,
10579             "field": "value",
10580             "description": ""
10581           },
10582           {
10583             "group": "Body",
10584             "type": "String",
10585             "optional": true,
10586             "field": "description",
10587             "description": ""
10588           },
10589           {
10590             "group": "Body",
10591             "type": "Virtual",
10592             "optional": true,
10593             "field": "name",
10594             "description": ""
10595           }
10596         ]
10597       }
10598     },
10599     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10600     "version": "0.0.0",
10601     "filename": "server/api/faxAccount/index.js",
10602     "groupTitle": "Fax_Accounts"
10603   },
10604   {
10605     "type": "post",
10606     "url": "/api/fax/accounts/{id}/applications",
10607     "title": "Creates new applications",
10608     "examples": [
10609       {
10610         "title": "Example usage:",
10611         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10612         "type": "json"
10613       }
10614     ],
10615     "name": "addApplications",
10616     "group": "Fax_Accounts",
10617     "parameter": {
10618       "fields": {
10619         "Body": [
10620           {
10621             "group": "Body",
10622             "type": "Integer",
10623             "optional": false,
10624             "field": "priority",
10625             "description": ""
10626           },
10627           {
10628             "group": "Body",
10629             "type": "String",
10630             "optional": false,
10631             "field": "app",
10632             "description": ""
10633           },
10634           {
10635             "group": "Body",
10636             "type": "Text",
10637             "optional": true,
10638             "field": "appdata",
10639             "description": ""
10640           },
10641           {
10642             "group": "Body",
10643             "type": "String",
10644             "optional": true,
10645             "field": "description",
10646             "description": ""
10647           },
10648           {
10649             "group": "Body",
10650             "type": "String",
10651             "optional": true,
10652             "field": "interval",
10653             "description": ""
10654           }
10655         ]
10656       }
10657     },
10658     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10659     "version": "0.0.0",
10660     "filename": "server/api/faxAccount/index.js",
10661     "groupTitle": "Fax_Accounts"
10662   },
10663   {
10664     "type": "post",
10665     "url": "/api/fax/accounts/addaccountapplications",
10666     "title": "Creates new account and applications",
10667     "examples": [
10668       {
10669         "title": "Example usage:",
10670         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10671         "type": "json"
10672       }
10673     ],
10674     "name": "addApplications",
10675     "group": "Fax_Accounts",
10676     "parameter": {
10677       "fields": {
10678         "Body": [
10679           {
10680             "group": "Body",
10681             "type": "Integer",
10682             "optional": false,
10683             "field": "priority",
10684             "description": ""
10685           },
10686           {
10687             "group": "Body",
10688             "type": "String",
10689             "optional": false,
10690             "field": "app",
10691             "description": ""
10692           },
10693           {
10694             "group": "Body",
10695             "type": "Text",
10696             "optional": true,
10697             "field": "appdata",
10698             "description": ""
10699           },
10700           {
10701             "group": "Body",
10702             "type": "String",
10703             "optional": true,
10704             "field": "description",
10705             "description": ""
10706           },
10707           {
10708             "group": "Body",
10709             "type": "String",
10710             "optional": true,
10711             "field": "interval",
10712             "description": ""
10713           }
10714         ]
10715       }
10716     },
10717     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10718     "version": "0.0.0",
10719     "filename": "server/api/faxAccount/index.js",
10720     "groupTitle": "Fax_Accounts"
10721   },
10722   {
10723     "type": "post",
10724     "url": "/api/fax/accounts/{id}/dispositions",
10725     "title": "Creates new disposition",
10726     "examples": [
10727       {
10728         "title": "Example usage:",
10729         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10730         "type": "json"
10731       }
10732     ],
10733     "name": "addDisposition",
10734     "group": "Fax_Accounts",
10735     "parameter": {
10736       "fields": {
10737         "Body": [
10738           {
10739             "group": "Body",
10740             "type": "String",
10741             "optional": false,
10742             "field": "name",
10743             "description": ""
10744           },
10745           {
10746             "group": "Body",
10747             "type": "String",
10748             "allowedValues": [
10749               "\"first\"",
10750               "\"second\"",
10751               "\"third\""
10752             ],
10753             "optional": false,
10754             "field": "level",
10755             "description": ""
10756           },
10757           {
10758             "group": "Body",
10759             "type": "String",
10760             "optional": true,
10761             "field": "description",
10762             "description": ""
10763           }
10764         ]
10765       }
10766     },
10767     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10768     "version": "0.0.0",
10769     "filename": "server/api/faxAccount/index.js",
10770     "groupTitle": "Fax_Accounts"
10771   },
10772   {
10773     "type": "post",
10774     "url": "/api/fax/accounts/{id}/interactions",
10775     "title": "Creates new interactions",
10776     "examples": [
10777       {
10778         "title": "Example usage:",
10779         "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",
10780         "type": "json"
10781       }
10782     ],
10783     "name": "addInteraction",
10784     "group": "Fax_Accounts",
10785     "parameter": {
10786       "fields": {
10787         "Body": [
10788           {
10789             "group": "Body",
10790             "type": "Boolean",
10791             "optional": true,
10792             "field": "closed",
10793             "description": ""
10794           },
10795           {
10796             "group": "Body",
10797             "type": "String",
10798             "optional": true,
10799             "field": "closedAt",
10800             "description": ""
10801           },
10802           {
10803             "group": "Body",
10804             "type": "String",
10805             "optional": true,
10806             "field": "disposition",
10807             "description": ""
10808           },
10809           {
10810             "group": "Body",
10811             "type": "String",
10812             "optional": true,
10813             "field": "secondDisposition",
10814             "description": ""
10815           },
10816           {
10817             "group": "Body",
10818             "type": "String",
10819             "optional": true,
10820             "field": "thirdDisposition",
10821             "description": ""
10822           },
10823           {
10824             "group": "Body",
10825             "type": "String",
10826             "optional": true,
10827             "field": "note",
10828             "description": ""
10829           },
10830           {
10831             "group": "Body",
10832             "type": "String",
10833             "optional": true,
10834             "field": "read1stAt",
10835             "description": ""
10836           },
10837           {
10838             "group": "Body",
10839             "type": "String",
10840             "optional": true,
10841             "field": "fax",
10842             "description": ""
10843           },
10844           {
10845             "group": "Body",
10846             "type": "String",
10847             "allowedValues": [
10848               "\"in\"",
10849               "\"out\""
10850             ],
10851             "optional": false,
10852             "field": "firstMsgDirection",
10853             "description": ""
10854           },
10855           {
10856             "group": "Body",
10857             "type": "String",
10858             "optional": true,
10859             "field": "lastMsgAt",
10860             "description": ""
10861           },
10862           {
10863             "group": "Body",
10864             "type": "String",
10865             "allowedValues": [
10866               "\"in\"",
10867               "\"out\""
10868             ],
10869             "optional": false,
10870             "field": "lastMsgDirection",
10871             "description": ""
10872           }
10873         ]
10874       }
10875     },
10876     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10877     "version": "0.0.0",
10878     "filename": "server/api/faxAccount/index.js",
10879     "groupTitle": "Fax_Accounts"
10880   },
10881   {
10882     "type": "get",
10883     "url": "/api/fax/accounts/{id}/canned_answers",
10884     "title": "Gets account canned answers",
10885     "examples": [
10886       {
10887         "title": "Example usage:",
10888         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10889         "type": "json"
10890       }
10891     ],
10892     "name": "getAnswers",
10893     "group": "Fax_Accounts",
10894     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10895     "version": "0.0.0",
10896     "filename": "server/api/faxAccount/index.js",
10897     "groupTitle": "Fax_Accounts"
10898   },
10899   {
10900     "type": "get",
10901     "url": "/api/fax/accounts/{id}/applications",
10902     "title": "Gets account pplications",
10903     "examples": [
10904       {
10905         "title": "Example usage:",
10906         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10907         "type": "json"
10908       }
10909     ],
10910     "name": "getApplications",
10911     "group": "Fax_Accounts",
10912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10913     "version": "0.0.0",
10914     "filename": "server/api/faxAccount/index.js",
10915     "groupTitle": "Fax_Accounts"
10916   },
10917   {
10918     "type": "get",
10919     "url": "/api/fax/accounts/{id}/dispositions",
10920     "title": "Gets account dispositions",
10921     "examples": [
10922       {
10923         "title": "Example usage:",
10924         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10925         "type": "json"
10926       }
10927     ],
10928     "name": "getDispositions",
10929     "group": "Fax_Accounts",
10930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10931     "version": "0.0.0",
10932     "filename": "server/api/faxAccount/index.js",
10933     "groupTitle": "Fax_Accounts"
10934   },
10935   {
10936     "type": "get",
10937     "url": "/api/fax/accounts/{id}/interactions",
10938     "title": "Gets account interactions",
10939     "examples": [
10940       {
10941         "title": "Example usage:",
10942         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10943         "type": "json"
10944       }
10945     ],
10946     "name": "getInteraction",
10947     "group": "Fax_Accounts",
10948     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10949     "version": "0.0.0",
10950     "filename": "server/api/faxAccount/index.js",
10951     "groupTitle": "Fax_Accounts"
10952   },
10953   {
10954     "type": "get",
10955     "url": "/api/fax/accounts/{id}/messages",
10956     "title": "Gets account messages",
10957     "examples": [
10958       {
10959         "title": "Example usage:",
10960         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10961         "type": "json"
10962       }
10963     ],
10964     "name": "getMessages",
10965     "group": "Fax_Accounts",
10966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10967     "version": "0.0.0",
10968     "filename": "server/api/faxAccount/index.js",
10969     "groupTitle": "Fax_Accounts"
10970   },
10971   {
10972     "type": "post",
10973     "url": "/api/fax/accounts/{id}/send",
10974     "title": "Send new fax",
10975     "examples": [
10976       {
10977         "title": "Example usage:",
10978         "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",
10979         "type": "json"
10980       }
10981     ],
10982     "name": "sendFax",
10983     "group": "Fax_Accounts",
10984     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10985     "version": "0.0.0",
10986     "filename": "server/api/faxAccount/index.js",
10987     "groupTitle": "Fax_Accounts"
10988   },
10989   {
10990     "type": "put",
10991     "url": "/api/fax/accounts/{id}",
10992     "title": "Update an existing Account",
10993     "examples": [
10994       {
10995         "title": "Example usage:",
10996         "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",
10997         "type": "json"
10998       }
10999     ],
11000     "name": "updateAccounts",
11001     "group": "Fax_Accounts",
11002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11003     "version": "0.0.0",
11004     "filename": "server/api/faxAccount/index.js",
11005     "groupTitle": "Fax_Accounts"
11006   },
11007   {
11008     "type": "post",
11009     "url": "/api/fax/accounts/updateaccountapplications",
11010     "title": "Update account and applications",
11011     "examples": [
11012       {
11013         "title": "Example usage:",
11014         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11015         "type": "json"
11016       }
11017     ],
11018     "name": "updateApplications",
11019     "group": "Fax_Accounts",
11020     "parameter": {
11021       "fields": {
11022         "Body": [
11023           {
11024             "group": "Body",
11025             "type": "Integer",
11026             "optional": false,
11027             "field": "priority",
11028             "description": ""
11029           },
11030           {
11031             "group": "Body",
11032             "type": "String",
11033             "optional": false,
11034             "field": "app",
11035             "description": ""
11036           },
11037           {
11038             "group": "Body",
11039             "type": "Text",
11040             "optional": true,
11041             "field": "appdata",
11042             "description": ""
11043           },
11044           {
11045             "group": "Body",
11046             "type": "String",
11047             "optional": true,
11048             "field": "description",
11049             "description": ""
11050           },
11051           {
11052             "group": "Body",
11053             "type": "String",
11054             "optional": true,
11055             "field": "interval",
11056             "description": ""
11057           }
11058         ]
11059       }
11060     },
11061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11062     "version": "0.0.0",
11063     "filename": "server/api/faxAccount/index.js",
11064     "groupTitle": "Fax_Accounts"
11065   },
11066   {
11067     "type": "post",
11068     "url": "/api/fax/applications",
11069     "title": "Creates a new Application",
11070     "examples": [
11071       {
11072         "title": "Example usage:",
11073         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11074         "type": "json"
11075       }
11076     ],
11077     "name": "CreateApplications",
11078     "group": "Fax_Applications",
11079     "parameter": {
11080       "fields": {
11081         "Body": [
11082           {
11083             "group": "Body",
11084             "type": "Integer",
11085             "optional": false,
11086             "field": "priority",
11087             "description": ""
11088           },
11089           {
11090             "group": "Body",
11091             "type": "String",
11092             "optional": false,
11093             "field": "app",
11094             "description": ""
11095           },
11096           {
11097             "group": "Body",
11098             "type": "Text",
11099             "optional": true,
11100             "field": "appdata",
11101             "description": ""
11102           },
11103           {
11104             "group": "Body",
11105             "type": "String",
11106             "optional": true,
11107             "field": "description",
11108             "description": ""
11109           },
11110           {
11111             "group": "Body",
11112             "type": "String",
11113             "optional": true,
11114             "field": "interval",
11115             "description": ""
11116           }
11117         ]
11118       }
11119     },
11120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11121     "version": "0.0.0",
11122     "filename": "server/api/faxApplication/index.js",
11123     "groupTitle": "Fax_Applications"
11124   },
11125   {
11126     "type": "delete",
11127     "url": "/api/fax/applications/{id}",
11128     "title": "Deletes a Application",
11129     "examples": [
11130       {
11131         "title": "Example usage:",
11132         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
11133         "type": "json"
11134       }
11135     ],
11136     "name": "DeleteApplications",
11137     "group": "Fax_Applications",
11138     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11139     "version": "0.0.0",
11140     "filename": "server/api/faxApplication/index.js",
11141     "groupTitle": "Fax_Applications"
11142   },
11143   {
11144     "type": "get",
11145     "url": "/api/fax/applications",
11146     "title": "Gets a list of Applications",
11147     "examples": [
11148       {
11149         "title": "Example usage:",
11150         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
11151         "type": "json"
11152       }
11153     ],
11154     "name": "GetApplications",
11155     "group": "Fax_Applications",
11156     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/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>",
11157     "version": "0.0.0",
11158     "filename": "server/api/faxApplication/index.js",
11159     "groupTitle": "Fax_Applications"
11160   },
11161   {
11162     "type": "get",
11163     "url": "/api/fax/applications/{id}",
11164     "title": "Gets a single Application",
11165     "examples": [
11166       {
11167         "title": "Example usage:",
11168         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
11169         "type": "json"
11170       }
11171     ],
11172     "name": "ShowApplications",
11173     "group": "Fax_Applications",
11174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11175     "version": "0.0.0",
11176     "filename": "server/api/faxApplication/index.js",
11177     "groupTitle": "Fax_Applications"
11178   },
11179   {
11180     "type": "put",
11181     "url": "/api/fax/applications/{id}",
11182     "title": "Update an existing Application",
11183     "examples": [
11184       {
11185         "title": "Example usage:",
11186         "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",
11187         "type": "json"
11188       }
11189     ],
11190     "name": "updateApplications",
11191     "group": "Fax_Applications",
11192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11193     "version": "0.0.0",
11194     "filename": "server/api/faxApplication/index.js",
11195     "groupTitle": "Fax_Applications"
11196   },
11197   {
11198     "type": "post",
11199     "url": "/api/fax/interactions/{id}/tags",
11200     "title": "Add tags to the interaction",
11201     "examples": [
11202       {
11203         "title": "Example usage:",
11204         "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",
11205         "type": "json"
11206       }
11207     ],
11208     "name": "AddTags",
11209     "group": "Fax_Interactions",
11210     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11211     "version": "0.0.0",
11212     "filename": "server/api/faxInteraction/index.js",
11213     "groupTitle": "Fax_Interactions"
11214   },
11215   {
11216     "type": "post",
11217     "url": "/api/fax/interactions",
11218     "title": "Creates a new Interaction",
11219     "examples": [
11220       {
11221         "title": "Example usage:",
11222         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11223         "type": "json"
11224       }
11225     ],
11226     "name": "CreateInteractions",
11227     "group": "Fax_Interactions",
11228     "parameter": {
11229       "fields": {
11230         "Body": [
11231           {
11232             "group": "Body",
11233             "type": "Boolean",
11234             "optional": true,
11235             "field": "closed",
11236             "description": ""
11237           },
11238           {
11239             "group": "Body",
11240             "type": "String",
11241             "optional": true,
11242             "field": "closedAt",
11243             "description": ""
11244           },
11245           {
11246             "group": "Body",
11247             "type": "String",
11248             "optional": true,
11249             "field": "disposition",
11250             "description": ""
11251           },
11252           {
11253             "group": "Body",
11254             "type": "String",
11255             "optional": true,
11256             "field": "secondDisposition",
11257             "description": ""
11258           },
11259           {
11260             "group": "Body",
11261             "type": "String",
11262             "optional": true,
11263             "field": "thirdDisposition",
11264             "description": ""
11265           },
11266           {
11267             "group": "Body",
11268             "type": "String",
11269             "optional": true,
11270             "field": "note",
11271             "description": ""
11272           },
11273           {
11274             "group": "Body",
11275             "type": "String",
11276             "optional": true,
11277             "field": "read1stAt",
11278             "description": ""
11279           },
11280           {
11281             "group": "Body",
11282             "type": "String",
11283             "optional": true,
11284             "field": "fax",
11285             "description": ""
11286           },
11287           {
11288             "group": "Body",
11289             "type": "String",
11290             "allowedValues": [
11291               "\"in\"",
11292               "\"out\""
11293             ],
11294             "optional": false,
11295             "field": "firstMsgDirection",
11296             "description": ""
11297           },
11298           {
11299             "group": "Body",
11300             "type": "String",
11301             "optional": true,
11302             "field": "lastMsgAt",
11303             "description": ""
11304           },
11305           {
11306             "group": "Body",
11307             "type": "String",
11308             "allowedValues": [
11309               "\"in\"",
11310               "\"out\""
11311             ],
11312             "optional": false,
11313             "field": "lastMsgDirection",
11314             "description": ""
11315           }
11316         ]
11317       }
11318     },
11319     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11320     "version": "0.0.0",
11321     "filename": "server/api/faxInteraction/index.js",
11322     "groupTitle": "Fax_Interactions"
11323   },
11324   {
11325     "type": "delete",
11326     "url": "/api/fax/interactions/{id}",
11327     "title": "Deletes a Interaction",
11328     "examples": [
11329       {
11330         "title": "Example usage:",
11331         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11332         "type": "json"
11333       }
11334     ],
11335     "name": "DeleteInteractions",
11336     "group": "Fax_Interactions",
11337     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11338     "version": "0.0.0",
11339     "filename": "server/api/faxInteraction/index.js",
11340     "groupTitle": "Fax_Interactions"
11341   },
11342   {
11343     "type": "get",
11344     "url": "/api/fax/interactions/describe",
11345     "title": "Gets table info about Interactions",
11346     "examples": [
11347       {
11348         "title": "Example usage:",
11349         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11350         "type": "json"
11351       }
11352     ],
11353     "name": "DescribeInteractions",
11354     "group": "Fax_Interactions",
11355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11356     "version": "0.0.0",
11357     "filename": "server/api/faxInteraction/index.js",
11358     "groupTitle": "Fax_Interactions"
11359   },
11360   {
11361     "type": "get",
11362     "url": "/api/fax/interactions",
11363     "title": "Gets a list of Interactions",
11364     "examples": [
11365       {
11366         "title": "Example usage:",
11367         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11368         "type": "json"
11369       }
11370     ],
11371     "name": "GetInteractions",
11372     "group": "Fax_Interactions",
11373     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11374     "version": "0.0.0",
11375     "filename": "server/api/faxInteraction/index.js",
11376     "groupTitle": "Fax_Interactions"
11377   },
11378   {
11379     "type": "delete",
11380     "url": "/api/fax/interactions/{id}/tags",
11381     "title": "Removes tags from interaction",
11382     "examples": [
11383       {
11384         "title": "Example usage:",
11385         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11386         "type": "json"
11387       }
11388     ],
11389     "name": "RemoveTags",
11390     "group": "Fax_Interactions",
11391     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11392     "version": "0.0.0",
11393     "filename": "server/api/faxInteraction/index.js",
11394     "groupTitle": "Fax_Interactions"
11395   },
11396   {
11397     "type": "get",
11398     "url": "/api/fax/interactions/{id}",
11399     "title": "Gets a single Interaction",
11400     "examples": [
11401       {
11402         "title": "Example usage:",
11403         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11404         "type": "json"
11405       }
11406     ],
11407     "name": "ShowInteractions",
11408     "group": "Fax_Interactions",
11409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11410     "version": "0.0.0",
11411     "filename": "server/api/faxInteraction/index.js",
11412     "groupTitle": "Fax_Interactions"
11413   },
11414   {
11415     "type": "post",
11416     "url": "/api/fax/interactions/{id}/messages",
11417     "title": "Creates new messages",
11418     "examples": [
11419       {
11420         "title": "Example usage:",
11421         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11422         "type": "json"
11423       }
11424     ],
11425     "name": "addMessage",
11426     "group": "Fax_Interactions",
11427     "parameter": {
11428       "fields": {
11429         "Body": [
11430           {
11431             "group": "Body",
11432             "type": "Text",
11433             "optional": false,
11434             "field": "body",
11435             "description": ""
11436           },
11437           {
11438             "group": "Body",
11439             "type": "Boolean",
11440             "optional": true,
11441             "field": "read",
11442             "description": ""
11443           },
11444           {
11445             "group": "Body",
11446             "type": "String",
11447             "allowedValues": [
11448               "\"in\"",
11449               "\"out\""
11450             ],
11451             "optional": false,
11452             "field": "direction",
11453             "description": ""
11454           },
11455           {
11456             "group": "Body",
11457             "type": "Text",
11458             "optional": true,
11459             "field": "failMessage",
11460             "description": ""
11461           },
11462           {
11463             "group": "Body",
11464             "type": "String",
11465             "optional": true,
11466             "field": "readAt",
11467             "description": ""
11468           }
11469         ]
11470       }
11471     },
11472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11473     "version": "0.0.0",
11474     "filename": "server/api/faxInteraction/index.js",
11475     "groupTitle": "Fax_Interactions"
11476   },
11477   {
11478     "type": "get",
11479     "url": "/api/fax/interactions/{id}/download",
11480     "title": "Get interactions",
11481     "examples": [
11482       {
11483         "title": "Example usage:",
11484         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11485         "type": "json"
11486       }
11487     ],
11488     "name": "download",
11489     "group": "Fax_Interactions",
11490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11491     "version": "0.0.0",
11492     "filename": "server/api/faxInteraction/index.js",
11493     "groupTitle": "Fax_Interactions"
11494   },
11495   {
11496     "type": "get",
11497     "url": "/api/fax/interactions/{id}/messages",
11498     "title": "Gets interaction messages",
11499     "examples": [
11500       {
11501         "title": "Example usage:",
11502         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11503         "type": "json"
11504       }
11505     ],
11506     "name": "getMessages",
11507     "group": "Fax_Interactions",
11508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11509     "version": "0.0.0",
11510     "filename": "server/api/faxInteraction/index.js",
11511     "groupTitle": "Fax_Interactions"
11512   },
11513   {
11514     "type": "put",
11515     "url": "/api/fax/interactions/{id}",
11516     "title": "Update an existing Interaction",
11517     "examples": [
11518       {
11519         "title": "Example usage:",
11520         "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",
11521         "type": "json"
11522       }
11523     ],
11524     "name": "updateInteractions",
11525     "group": "Fax_Interactions",
11526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11527     "version": "0.0.0",
11528     "filename": "server/api/faxInteraction/index.js",
11529     "groupTitle": "Fax_Interactions"
11530   },
11531   {
11532     "type": "get",
11533     "url": "/api/fax/messages/{id}/download",
11534     "title": "Get message",
11535     "examples": [
11536       {
11537         "title": "Example usage:",
11538         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11539         "type": "json"
11540       }
11541     ],
11542     "name": "download",
11543     "group": "Fax_Message",
11544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11545     "version": "0.0.0",
11546     "filename": "server/api/faxMessage/index.js",
11547     "groupTitle": "Fax_Message"
11548   },
11549   {
11550     "type": "delete",
11551     "url": "/api/fax/messages/{id}",
11552     "title": "Deletes a Message",
11553     "examples": [
11554       {
11555         "title": "Example usage:",
11556         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11557         "type": "json"
11558       }
11559     ],
11560     "name": "DeleteMessages",
11561     "group": "Fax_Messages",
11562     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11563     "version": "0.0.0",
11564     "filename": "server/api/faxMessage/index.js",
11565     "groupTitle": "Fax_Messages"
11566   },
11567   {
11568     "type": "get",
11569     "url": "/api/fax/messages/describe",
11570     "title": "Gets table info about Messages",
11571     "examples": [
11572       {
11573         "title": "Example usage:",
11574         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11575         "type": "json"
11576       }
11577     ],
11578     "name": "DescribeMessages",
11579     "group": "Fax_Messages",
11580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11581     "version": "0.0.0",
11582     "filename": "server/api/faxMessage/index.js",
11583     "groupTitle": "Fax_Messages"
11584   },
11585   {
11586     "type": "get",
11587     "url": "/api/fax/messages",
11588     "title": "Gets a list of Messages",
11589     "examples": [
11590       {
11591         "title": "Example usage:",
11592         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11593         "type": "json"
11594       }
11595     ],
11596     "name": "GetMessages",
11597     "group": "Fax_Messages",
11598     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/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>",
11599     "version": "0.0.0",
11600     "filename": "server/api/faxMessage/index.js",
11601     "groupTitle": "Fax_Messages"
11602   },
11603   {
11604     "type": "get",
11605     "url": "/api/fax/messages/{id}",
11606     "title": "Gets a single Message",
11607     "examples": [
11608       {
11609         "title": "Example usage:",
11610         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11611         "type": "json"
11612       }
11613     ],
11614     "name": "ShowMessages",
11615     "group": "Fax_Messages",
11616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11617     "version": "0.0.0",
11618     "filename": "server/api/faxMessage/index.js",
11619     "groupTitle": "Fax_Messages"
11620   },
11621   {
11622     "type": "put",
11623     "url": "/api/fax/messages/{id}/accept",
11624     "title": "Accepts message",
11625     "examples": [
11626       {
11627         "title": "Example usage:",
11628         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11629         "type": "json"
11630       }
11631     ],
11632     "name": "acceptMessage",
11633     "group": "Fax_Messages",
11634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11635     "version": "0.0.0",
11636     "filename": "server/api/faxMessage/index.js",
11637     "groupTitle": "Fax_Messages"
11638   },
11639   {
11640     "type": "put",
11641     "url": "/api/fax/messages/{id}/reject",
11642     "title": "Rejects message",
11643     "examples": [
11644       {
11645         "title": "Example usage:",
11646         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11647         "type": "json"
11648       }
11649     ],
11650     "name": "rejectMessage",
11651     "group": "Fax_Messages",
11652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11653     "version": "0.0.0",
11654     "filename": "server/api/faxMessage/index.js",
11655     "groupTitle": "Fax_Messages"
11656   },
11657   {
11658     "type": "post",
11659     "url": "/api/fax/messages",
11660     "title": "Create message and send Fax",
11661     "examples": [
11662       {
11663         "title": "Example usage:",
11664         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11665         "type": "json"
11666       }
11667     ],
11668     "name": "rejectMessage",
11669     "group": "Fax_Messages",
11670     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11671     "version": "0.0.0",
11672     "filename": "server/api/faxMessage/index.js",
11673     "groupTitle": "Fax_Messages"
11674   },
11675   {
11676     "type": "put",
11677     "url": "/api/fax/messages/{id}",
11678     "title": "Update an existing Message",
11679     "examples": [
11680       {
11681         "title": "Example usage:",
11682         "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",
11683         "type": "json"
11684       }
11685     ],
11686     "name": "updateMessages",
11687     "group": "Fax_Messages",
11688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11689     "version": "0.0.0",
11690     "filename": "server/api/faxMessage/index.js",
11691     "groupTitle": "Fax_Messages"
11692   },
11693   {
11694     "type": "post",
11695     "url": "/api/fax/reports/queue",
11696     "title": "Creates a new Fax Queue Report",
11697     "examples": [
11698       {
11699         "title": "Example usage:",
11700         "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",
11701         "type": "json"
11702       }
11703     ],
11704     "name": "CreateFax_Queue_Reports",
11705     "group": "Fax_Queue_Reports",
11706     "parameter": {
11707       "fields": {
11708         "Body": [
11709           {
11710             "group": "Body",
11711             "type": "String",
11712             "optional": false,
11713             "field": "uniqueid",
11714             "description": ""
11715           },
11716           {
11717             "group": "Body",
11718             "type": "String",
11719             "optional": true,
11720             "field": "from",
11721             "description": ""
11722           },
11723           {
11724             "group": "Body",
11725             "type": "String",
11726             "optional": true,
11727             "field": "joinAt",
11728             "description": ""
11729           },
11730           {
11731             "group": "Body",
11732             "type": "String",
11733             "optional": true,
11734             "field": "leaveAt",
11735             "description": ""
11736           },
11737           {
11738             "group": "Body",
11739             "type": "String",
11740             "optional": true,
11741             "field": "acceptAt",
11742             "description": ""
11743           },
11744           {
11745             "group": "Body",
11746             "type": "String",
11747             "optional": true,
11748             "field": "exitAt",
11749             "description": ""
11750           },
11751           {
11752             "group": "Body",
11753             "type": "String",
11754             "optional": true,
11755             "field": "reason",
11756             "description": ""
11757           }
11758         ]
11759       }
11760     },
11761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11762     "version": "0.0.0",
11763     "filename": "server/api/faxQueueReport/index.js",
11764     "groupTitle": "Fax_Queue_Reports"
11765   },
11766   {
11767     "type": "delete",
11768     "url": "/api/fax/reports/queue/{id}",
11769     "title": "Deletes a Fax Queue Report",
11770     "examples": [
11771       {
11772         "title": "Example usage:",
11773         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11774         "type": "json"
11775       }
11776     ],
11777     "name": "DeleteFax_Queue_Reports",
11778     "group": "Fax_Queue_Reports",
11779     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11780     "version": "0.0.0",
11781     "filename": "server/api/faxQueueReport/index.js",
11782     "groupTitle": "Fax_Queue_Reports"
11783   },
11784   {
11785     "type": "get",
11786     "url": "/api/fax/reports/queue/describe",
11787     "title": "Gets table info about Fax Queue Reports",
11788     "examples": [
11789       {
11790         "title": "Example usage:",
11791         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11792         "type": "json"
11793       }
11794     ],
11795     "name": "DescribeFax_Queue_Reports",
11796     "group": "Fax_Queue_Reports",
11797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11798     "version": "0.0.0",
11799     "filename": "server/api/faxQueueReport/index.js",
11800     "groupTitle": "Fax_Queue_Reports"
11801   },
11802   {
11803     "type": "get",
11804     "url": "/api/fax/reports/queue",
11805     "title": "Gets a list of Fax Queue Reports",
11806     "examples": [
11807       {
11808         "title": "Example usage:",
11809         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11810         "type": "json"
11811       }
11812     ],
11813     "name": "GetFax_Queue_Reports",
11814     "group": "Fax_Queue_Reports",
11815     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
11816     "version": "0.0.0",
11817     "filename": "server/api/faxQueueReport/index.js",
11818     "groupTitle": "Fax_Queue_Reports"
11819   },
11820   {
11821     "type": "get",
11822     "url": "/api/fax/reports/queue/{id}",
11823     "title": "Gets a single Fax Queue Report",
11824     "examples": [
11825       {
11826         "title": "Example usage:",
11827         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11828         "type": "json"
11829       }
11830     ],
11831     "name": "ShowFax_Queue_Reports",
11832     "group": "Fax_Queue_Reports",
11833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11834     "version": "0.0.0",
11835     "filename": "server/api/faxQueueReport/index.js",
11836     "groupTitle": "Fax_Queue_Reports"
11837   },
11838   {
11839     "type": "put",
11840     "url": "/api/fax/reports/queue/{id}",
11841     "title": "Update an existing Fax Queue Report",
11842     "examples": [
11843       {
11844         "title": "Example usage:",
11845         "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",
11846         "type": "json"
11847       }
11848     ],
11849     "name": "updateFax_Queue_Reports",
11850     "group": "Fax_Queue_Reports",
11851     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11852     "version": "0.0.0",
11853     "filename": "server/api/faxQueueReport/index.js",
11854     "groupTitle": "Fax_Queue_Reports"
11855   },
11856   {
11857     "type": "post",
11858     "url": "/api/fax/queues/{id}/users",
11859     "title": "Add agents to a queue",
11860     "examples": [
11861       {
11862         "title": "Example usage:",
11863         "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",
11864         "type": "json"
11865       }
11866     ],
11867     "name": "AddAgents",
11868     "group": "Fax_Queues",
11869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11870     "version": "0.0.0",
11871     "filename": "server/api/faxQueue/index.js",
11872     "groupTitle": "Fax_Queues"
11873   },
11874   {
11875     "type": "post",
11876     "url": "/api/fax/queues/{id}/teams",
11877     "title": "Add teams to a queue",
11878     "examples": [
11879       {
11880         "title": "Example usage:",
11881         "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",
11882         "type": "json"
11883       }
11884     ],
11885     "name": "AddTeams",
11886     "group": "Fax_Queues",
11887     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11888     "version": "0.0.0",
11889     "filename": "server/api/faxQueue/index.js",
11890     "groupTitle": "Fax_Queues"
11891   },
11892   {
11893     "type": "post",
11894     "url": "/api/fax/queues",
11895     "title": "Creates a new Queue",
11896     "examples": [
11897       {
11898         "title": "Example usage:",
11899         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11900         "type": "json"
11901       }
11902     ],
11903     "name": "CreateQueues",
11904     "group": "Fax_Queues",
11905     "parameter": {
11906       "fields": {
11907         "Body": [
11908           {
11909             "group": "Body",
11910             "type": "String",
11911             "optional": false,
11912             "field": "name",
11913             "description": ""
11914           },
11915           {
11916             "group": "Body",
11917             "type": "String",
11918             "optional": true,
11919             "field": "description",
11920             "description": ""
11921           },
11922           {
11923             "group": "Body",
11924             "type": "Integer",
11925             "optional": false,
11926             "field": "timeout",
11927             "description": ""
11928           },
11929           {
11930             "group": "Body",
11931             "type": "String",
11932             "allowedValues": [
11933               "\"rrmemory\"",
11934               "\"beepall\"",
11935               "\"roundrobin\""
11936             ],
11937             "optional": false,
11938             "field": "strategy",
11939             "description": ""
11940           },
11941           {
11942             "group": "Body",
11943             "type": "Integer",
11944             "optional": true,
11945             "field": "lastAgent",
11946             "description": ""
11947           }
11948         ]
11949       }
11950     },
11951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11952     "version": "0.0.0",
11953     "filename": "server/api/faxQueue/index.js",
11954     "groupTitle": "Fax_Queues"
11955   },
11956   {
11957     "type": "delete",
11958     "url": "/api/fax/queues/{id}",
11959     "title": "Deletes a Queue",
11960     "examples": [
11961       {
11962         "title": "Example usage:",
11963         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11964         "type": "json"
11965       }
11966     ],
11967     "name": "DeleteQueues",
11968     "group": "Fax_Queues",
11969     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11970     "version": "0.0.0",
11971     "filename": "server/api/faxQueue/index.js",
11972     "groupTitle": "Fax_Queues"
11973   },
11974   {
11975     "type": "get",
11976     "url": "/api/fax/queues/describe",
11977     "title": "Gets table info about Queues",
11978     "examples": [
11979       {
11980         "title": "Example usage:",
11981         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11982         "type": "json"
11983       }
11984     ],
11985     "name": "DescribeQueues",
11986     "group": "Fax_Queues",
11987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11988     "version": "0.0.0",
11989     "filename": "server/api/faxQueue/index.js",
11990     "groupTitle": "Fax_Queues"
11991   },
11992   {
11993     "type": "get",
11994     "url": "/api/fax/queues/{id}/users",
11995     "title": "Gets queue agents",
11996     "examples": [
11997       {
11998         "title": "Example usage:",
11999         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
12000         "type": "json"
12001       }
12002     ],
12003     "name": "GetAgents",
12004     "group": "Fax_Queues",
12005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12006     "version": "0.0.0",
12007     "filename": "server/api/faxQueue/index.js",
12008     "groupTitle": "Fax_Queues"
12009   },
12010   {
12011     "type": "get",
12012     "url": "/api/fax/queues/{id}/members",
12013     "title": "GetMembers",
12014     "examples": [
12015       {
12016         "title": "Example usage:",
12017         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
12018         "type": "json"
12019       }
12020     ],
12021     "name": "GetMembers",
12022     "group": "Fax_Queues",
12023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12024     "version": "0.0.0",
12025     "filename": "server/api/faxQueue/index.js",
12026     "groupTitle": "Fax_Queues"
12027   },
12028   {
12029     "type": "get",
12030     "url": "/api/fax/queues",
12031     "title": "Gets a list of Queues",
12032     "examples": [
12033       {
12034         "title": "Example usage:",
12035         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
12036         "type": "json"
12037       }
12038     ],
12039     "name": "GetQueues",
12040     "group": "Fax_Queues",
12041     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12042     "version": "0.0.0",
12043     "filename": "server/api/faxQueue/index.js",
12044     "groupTitle": "Fax_Queues"
12045   },
12046   {
12047     "type": "get",
12048     "url": "/api/fax/queues/{id}/teams",
12049     "title": "Gets queues list",
12050     "examples": [
12051       {
12052         "title": "Example usage:",
12053         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
12054         "type": "json"
12055       }
12056     ],
12057     "name": "GetTeams",
12058     "group": "Fax_Queues",
12059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12060     "version": "0.0.0",
12061     "filename": "server/api/faxQueue/index.js",
12062     "groupTitle": "Fax_Queues"
12063   },
12064   {
12065     "type": "delete",
12066     "url": "/api/fax/queues/{id}/users",
12067     "title": "Removes agents from a queue",
12068     "examples": [
12069       {
12070         "title": "Example usage:",
12071         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12072         "type": "json"
12073       }
12074     ],
12075     "name": "RemoveAgents",
12076     "group": "Fax_Queues",
12077     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12078     "version": "0.0.0",
12079     "filename": "server/api/faxQueue/index.js",
12080     "groupTitle": "Fax_Queues"
12081   },
12082   {
12083     "type": "get",
12084     "url": "/api/fax/queues/{id}",
12085     "title": "Gets a single Queue",
12086     "examples": [
12087       {
12088         "title": "Example usage:",
12089         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
12090         "type": "json"
12091       }
12092     ],
12093     "name": "ShowQueues",
12094     "group": "Fax_Queues",
12095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12096     "version": "0.0.0",
12097     "filename": "server/api/faxQueue/index.js",
12098     "groupTitle": "Fax_Queues"
12099   },
12100   {
12101     "type": "put",
12102     "url": "/api/fax/queues/{id}",
12103     "title": "Update an existing Queue",
12104     "examples": [
12105       {
12106         "title": "Example usage:",
12107         "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",
12108         "type": "json"
12109       }
12110     ],
12111     "name": "updateQueues",
12112     "group": "Fax_Queues",
12113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12114     "version": "0.0.0",
12115     "filename": "server/api/faxQueue/index.js",
12116     "groupTitle": "Fax_Queues"
12117   },
12118   {
12119     "type": "post",
12120     "url": "/api/fax/reports/transfer",
12121     "title": "Creates a new Fax Transfer Report",
12122     "examples": [
12123       {
12124         "title": "Example usage:",
12125         "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",
12126         "type": "json"
12127       }
12128     ],
12129     "name": "CreateFax_Transfer_Reports",
12130     "group": "Fax_Transfer_Reports",
12131     "parameter": {
12132       "fields": {
12133         "Body": [
12134           {
12135             "group": "Body",
12136             "type": "String",
12137             "optional": false,
12138             "field": "uniqueid",
12139             "description": ""
12140           },
12141           {
12142             "group": "Body",
12143             "type": "String",
12144             "allowedValues": [
12145               "\"account\"",
12146               "\"agent\"",
12147               "\"queue\""
12148             ],
12149             "optional": false,
12150             "field": "type",
12151             "description": ""
12152           },
12153           {
12154             "group": "Body",
12155             "type": "String",
12156             "optional": false,
12157             "field": "transferredAt",
12158             "description": ""
12159           }
12160         ]
12161       }
12162     },
12163     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12164     "version": "0.0.0",
12165     "filename": "server/api/faxTransferReport/index.js",
12166     "groupTitle": "Fax_Transfer_Reports"
12167   },
12168   {
12169     "type": "delete",
12170     "url": "/api/fax/reports/transfer/{id}",
12171     "title": "Deletes a Fax Transfer Report",
12172     "examples": [
12173       {
12174         "title": "Example usage:",
12175         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
12176         "type": "json"
12177       }
12178     ],
12179     "name": "DeleteFax_Transfer_Reports",
12180     "group": "Fax_Transfer_Reports",
12181     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12182     "version": "0.0.0",
12183     "filename": "server/api/faxTransferReport/index.js",
12184     "groupTitle": "Fax_Transfer_Reports"
12185   },
12186   {
12187     "type": "get",
12188     "url": "/api/fax/reports/transfer/describe",
12189     "title": "Gets table info about Fax Transfer Reports",
12190     "examples": [
12191       {
12192         "title": "Example usage:",
12193         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
12194         "type": "json"
12195       }
12196     ],
12197     "name": "DescribeFax_Transfer_Reports",
12198     "group": "Fax_Transfer_Reports",
12199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12200     "version": "0.0.0",
12201     "filename": "server/api/faxTransferReport/index.js",
12202     "groupTitle": "Fax_Transfer_Reports"
12203   },
12204   {
12205     "type": "get",
12206     "url": "/api/fax/reports/transfer",
12207     "title": "Gets a list of Fax Transfer Reports",
12208     "examples": [
12209       {
12210         "title": "Example usage:",
12211         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
12212         "type": "json"
12213       }
12214     ],
12215     "name": "GetFax_Transfer_Reports",
12216     "group": "Fax_Transfer_Reports",
12217     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12218     "version": "0.0.0",
12219     "filename": "server/api/faxTransferReport/index.js",
12220     "groupTitle": "Fax_Transfer_Reports"
12221   },
12222   {
12223     "type": "get",
12224     "url": "/api/fax/reports/transfer/{id}",
12225     "title": "Gets a single Fax Transfer Report",
12226     "examples": [
12227       {
12228         "title": "Example usage:",
12229         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12230         "type": "json"
12231       }
12232     ],
12233     "name": "ShowFax_Transfer_Reports",
12234     "group": "Fax_Transfer_Reports",
12235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12236     "version": "0.0.0",
12237     "filename": "server/api/faxTransferReport/index.js",
12238     "groupTitle": "Fax_Transfer_Reports"
12239   },
12240   {
12241     "type": "put",
12242     "url": "/api/fax/reports/transfer/{id}",
12243     "title": "Update an existing Fax Transfer Report",
12244     "examples": [
12245       {
12246         "title": "Example usage:",
12247         "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",
12248         "type": "json"
12249       }
12250     ],
12251     "name": "updateFax_Transfer_Reports",
12252     "group": "Fax_Transfer_Reports",
12253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12254     "version": "0.0.0",
12255     "filename": "server/api/faxTransferReport/index.js",
12256     "groupTitle": "Fax_Transfer_Reports"
12257   },
12258   {
12259     "type": "post",
12260     "url": "/api/integrations/freshdesk/accounts",
12261     "title": "Creates a new Freshdesk Account",
12262     "examples": [
12263       {
12264         "title": "Example usage:",
12265         "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",
12266         "type": "json"
12267       }
12268     ],
12269     "name": "CreateFreshdesk_Accounts",
12270     "group": "Freshdesk_Accounts",
12271     "parameter": {
12272       "fields": {
12273         "Body": [
12274           {
12275             "group": "Body",
12276             "type": "String",
12277             "optional": true,
12278             "field": "name",
12279             "description": ""
12280           },
12281           {
12282             "group": "Body",
12283             "type": "String",
12284             "optional": true,
12285             "field": "description",
12286             "description": ""
12287           },
12288           {
12289             "group": "Body",
12290             "type": "String",
12291             "optional": true,
12292             "field": "username",
12293             "description": ""
12294           },
12295           {
12296             "group": "Body",
12297             "type": "String",
12298             "optional": true,
12299             "field": "apiKey",
12300             "description": ""
12301           },
12302           {
12303             "group": "Body",
12304             "type": "String",
12305             "optional": true,
12306             "field": "remoteUri",
12307             "description": ""
12308           },
12309           {
12310             "group": "Body",
12311             "type": "String",
12312             "optional": false,
12313             "field": "serverUrl",
12314             "description": ""
12315           }
12316         ]
12317       }
12318     },
12319     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12320     "version": "0.0.0",
12321     "filename": "server/api/intFreshdeskAccount/index.js",
12322     "groupTitle": "Freshdesk_Accounts"
12323   },
12324   {
12325     "type": "delete",
12326     "url": "/api/integrations/freshdesk/accounts/{id}",
12327     "title": "Deletes a Freshdesk Account",
12328     "examples": [
12329       {
12330         "title": "Example usage:",
12331         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12332         "type": "json"
12333       }
12334     ],
12335     "name": "DeleteFreshdesk_Accounts",
12336     "group": "Freshdesk_Accounts",
12337     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12338     "version": "0.0.0",
12339     "filename": "server/api/intFreshdeskAccount/index.js",
12340     "groupTitle": "Freshdesk_Accounts"
12341   },
12342   {
12343     "type": "get",
12344     "url": "/api/integrations/freshdesk/accounts",
12345     "title": "Gets a list of Freshdesk Accounts",
12346     "examples": [
12347       {
12348         "title": "Example usage:",
12349         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12350         "type": "json"
12351       }
12352     ],
12353     "name": "GetFreshdesk_Accounts",
12354     "group": "Freshdesk_Accounts",
12355     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12356     "version": "0.0.0",
12357     "filename": "server/api/intFreshdeskAccount/index.js",
12358     "groupTitle": "Freshdesk_Accounts"
12359   },
12360   {
12361     "type": "get",
12362     "url": "/api/integrations/freshdesk/accounts/{id}",
12363     "title": "Gets a single Freshdesk Account",
12364     "examples": [
12365       {
12366         "title": "Example usage:",
12367         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12368         "type": "json"
12369       }
12370     ],
12371     "name": "ShowFreshdesk_Accounts",
12372     "group": "Freshdesk_Accounts",
12373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12374     "version": "0.0.0",
12375     "filename": "server/api/intFreshdeskAccount/index.js",
12376     "groupTitle": "Freshdesk_Accounts"
12377   },
12378   {
12379     "type": "post",
12380     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12381     "title": "Creates new configuration",
12382     "examples": [
12383       {
12384         "title": "Example usage:",
12385         "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",
12386         "type": "json"
12387       }
12388     ],
12389     "name": "addConfiguration",
12390     "group": "Freshdesk_Accounts",
12391     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12392     "version": "0.0.0",
12393     "filename": "server/api/intFreshdeskAccount/index.js",
12394     "groupTitle": "Freshdesk_Accounts"
12395   },
12396   {
12397     "type": "get",
12398     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12399     "title": "Gets account configurations",
12400     "examples": [
12401       {
12402         "title": "Example usage:",
12403         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12404         "type": "json"
12405       }
12406     ],
12407     "name": "getConfigurations",
12408     "group": "Freshdesk_Accounts",
12409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12410     "version": "0.0.0",
12411     "filename": "server/api/intFreshdeskAccount/index.js",
12412     "groupTitle": "Freshdesk_Accounts"
12413   },
12414   {
12415     "type": "get",
12416     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12417     "title": "Gets account fields",
12418     "examples": [
12419       {
12420         "title": "Example usage:",
12421         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12422         "type": "json"
12423       }
12424     ],
12425     "name": "getFields",
12426     "group": "Freshdesk_Accounts",
12427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12428     "version": "0.0.0",
12429     "filename": "server/api/intFreshdeskAccount/index.js",
12430     "groupTitle": "Freshdesk_Accounts"
12431   },
12432   {
12433     "type": "put",
12434     "url": "/api/integrations/freshdesk/accounts/{id}",
12435     "title": "Update an existing Freshdesk Account",
12436     "examples": [
12437       {
12438         "title": "Example usage:",
12439         "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",
12440         "type": "json"
12441       }
12442     ],
12443     "name": "updateFreshdesk_Accounts",
12444     "group": "Freshdesk_Accounts",
12445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12446     "version": "0.0.0",
12447     "filename": "server/api/intFreshdeskAccount/index.js",
12448     "groupTitle": "Freshdesk_Accounts"
12449   },
12450   {
12451     "type": "post",
12452     "url": "/api/integrations/freshdesk/configurations",
12453     "title": "Creates a new Freshdesk Configuration",
12454     "examples": [
12455       {
12456         "title": "Example usage:",
12457         "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",
12458         "type": "json"
12459       }
12460     ],
12461     "name": "CreateFreshdesk_Configurations",
12462     "group": "Freshdesk_Configurations",
12463     "parameter": {
12464       "fields": {
12465         "Body": [
12466           {
12467             "group": "Body",
12468             "type": "String",
12469             "optional": true,
12470             "field": "name",
12471             "description": ""
12472           },
12473           {
12474             "group": "Body",
12475             "type": "String",
12476             "optional": true,
12477             "field": "description",
12478             "description": ""
12479           }
12480         ]
12481       }
12482     },
12483     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12484     "version": "0.0.0",
12485     "filename": "server/api/intFreshdeskConfiguration/index.js",
12486     "groupTitle": "Freshdesk_Configurations"
12487   },
12488   {
12489     "type": "delete",
12490     "url": "/api/integrations/freshdesk/configurations/{id}",
12491     "title": "Deletes a Freshdesk Configuration",
12492     "examples": [
12493       {
12494         "title": "Example usage:",
12495         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12496         "type": "json"
12497       }
12498     ],
12499     "name": "DeleteFreshdesk_Configurations",
12500     "group": "Freshdesk_Configurations",
12501     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12502     "version": "0.0.0",
12503     "filename": "server/api/intFreshdeskConfiguration/index.js",
12504     "groupTitle": "Freshdesk_Configurations"
12505   },
12506   {
12507     "type": "get",
12508     "url": "/api/integrations/freshdesk/configurations",
12509     "title": "Gets a list of Freshdesk Configurations",
12510     "examples": [
12511       {
12512         "title": "Example usage:",
12513         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12514         "type": "json"
12515       }
12516     ],
12517     "name": "GetFreshdesk_Configurations",
12518     "group": "Freshdesk_Configurations",
12519     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12520     "version": "0.0.0",
12521     "filename": "server/api/intFreshdeskConfiguration/index.js",
12522     "groupTitle": "Freshdesk_Configurations"
12523   },
12524   {
12525     "type": "get",
12526     "url": "/api/integrations/freshdesk/configurations/{id}",
12527     "title": "Gets a single Freshdesk Configuration",
12528     "examples": [
12529       {
12530         "title": "Example usage:",
12531         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12532         "type": "json"
12533       }
12534     ],
12535     "name": "ShowFreshdesk_Configurations",
12536     "group": "Freshdesk_Configurations",
12537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12538     "version": "0.0.0",
12539     "filename": "server/api/intFreshdeskConfiguration/index.js",
12540     "groupTitle": "Freshdesk_Configurations"
12541   },
12542   {
12543     "type": "get",
12544     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12545     "title": "Gets configurations descriptions",
12546     "examples": [
12547       {
12548         "title": "Example usage:",
12549         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12550         "type": "json"
12551       }
12552     ],
12553     "name": "getDescriptions",
12554     "group": "Freshdesk_Configurations",
12555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12556     "version": "0.0.0",
12557     "filename": "server/api/intFreshdeskConfiguration/index.js",
12558     "groupTitle": "Freshdesk_Configurations"
12559   },
12560   {
12561     "type": "get",
12562     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12563     "title": "Gets configurations fields",
12564     "examples": [
12565       {
12566         "title": "Example usage:",
12567         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12568         "type": "json"
12569       }
12570     ],
12571     "name": "getFields",
12572     "group": "Freshdesk_Configurations",
12573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12574     "version": "0.0.0",
12575     "filename": "server/api/intFreshdeskConfiguration/index.js",
12576     "groupTitle": "Freshdesk_Configurations"
12577   },
12578   {
12579     "type": "get",
12580     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12581     "title": "Gets configurations subjects",
12582     "examples": [
12583       {
12584         "title": "Example usage:",
12585         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12586         "type": "json"
12587       }
12588     ],
12589     "name": "getSubjects",
12590     "group": "Freshdesk_Configurations",
12591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12592     "version": "0.0.0",
12593     "filename": "server/api/intFreshdeskConfiguration/index.js",
12594     "groupTitle": "Freshdesk_Configurations"
12595   },
12596   {
12597     "type": "get",
12598     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12599     "title": "Gets configurations tags",
12600     "examples": [
12601       {
12602         "title": "Example usage:",
12603         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12604         "type": "json"
12605       }
12606     ],
12607     "name": "getTags",
12608     "group": "Freshdesk_Configurations",
12609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12610     "version": "0.0.0",
12611     "filename": "server/api/intFreshdeskConfiguration/index.js",
12612     "groupTitle": "Freshdesk_Configurations"
12613   },
12614   {
12615     "type": "post",
12616     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12617     "title": "Sets new tags",
12618     "examples": [
12619       {
12620         "title": "Example usage:",
12621         "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",
12622         "type": "json"
12623       }
12624     ],
12625     "name": "setTags",
12626     "group": "Freshdesk_Configurations",
12627     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12628     "version": "0.0.0",
12629     "filename": "server/api/intFreshdeskConfiguration/index.js",
12630     "groupTitle": "Freshdesk_Configurations"
12631   },
12632   {
12633     "type": "put",
12634     "url": "/api/integrations/freshdesk/configurations/{id}",
12635     "title": "Update an existing Freshdesk Configuration",
12636     "examples": [
12637       {
12638         "title": "Example usage:",
12639         "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",
12640         "type": "json"
12641       }
12642     ],
12643     "name": "updateFreshdesk_Configurations",
12644     "group": "Freshdesk_Configurations",
12645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12646     "version": "0.0.0",
12647     "filename": "server/api/intFreshdeskConfiguration/index.js",
12648     "groupTitle": "Freshdesk_Configurations"
12649   },
12650   {
12651     "type": "post",
12652     "url": "/api/integrations/freshdesk/fields",
12653     "title": "Creates a new Freshdesk Field",
12654     "examples": [
12655       {
12656         "title": "Example usage:",
12657         "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",
12658         "type": "json"
12659       }
12660     ],
12661     "name": "CreateFreshdesk_Fields",
12662     "group": "Freshdesk_Fields",
12663     "parameter": {
12664       "fields": {
12665         "Body": [
12666           {
12667             "group": "Body",
12668             "type": "String",
12669             "allowedValues": [
12670               "\"string\"",
12671               "\"variable\"",
12672               "\"customVariable\"",
12673               "\"keyValue\"",
12674               "\"picklist\""
12675             ],
12676             "optional": true,
12677             "field": "type",
12678             "description": ""
12679           },
12680           {
12681             "group": "Body",
12682             "type": "String",
12683             "optional": true,
12684             "field": "content",
12685             "description": ""
12686           },
12687           {
12688             "group": "Body",
12689             "type": "String",
12690             "optional": true,
12691             "field": "key",
12692             "description": ""
12693           },
12694           {
12695             "group": "Body",
12696             "type": "String",
12697             "allowedValues": [
12698               "\"string\"",
12699               "\"variable\"",
12700               "\"customVariable\""
12701             ],
12702             "optional": true,
12703             "field": "keyType",
12704             "description": ""
12705           },
12706           {
12707             "group": "Body",
12708             "type": "String",
12709             "optional": true,
12710             "field": "keyContent",
12711             "description": ""
12712           },
12713           {
12714             "group": "Body",
12715             "type": "String",
12716             "optional": true,
12717             "field": "idField",
12718             "description": ""
12719           },
12720           {
12721             "group": "Body",
12722             "type": "String",
12723             "optional": true,
12724             "field": "nameField",
12725             "description": ""
12726           },
12727           {
12728             "group": "Body",
12729             "type": "Boolean",
12730             "optional": true,
12731             "field": "customField",
12732             "description": ""
12733           },
12734           {
12735             "group": "Body",
12736             "type": "String",
12737             "optional": true,
12738             "field": "variableName",
12739             "description": ""
12740           }
12741         ]
12742       }
12743     },
12744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12745     "version": "0.0.0",
12746     "filename": "server/api/intFreshdeskField/index.js",
12747     "groupTitle": "Freshdesk_Fields"
12748   },
12749   {
12750     "type": "delete",
12751     "url": "/api/integrations/freshdesk/fields/{id}",
12752     "title": "Deletes a Freshdesk Field",
12753     "examples": [
12754       {
12755         "title": "Example usage:",
12756         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12757         "type": "json"
12758       }
12759     ],
12760     "name": "DeleteFreshdesk_Fields",
12761     "group": "Freshdesk_Fields",
12762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12763     "version": "0.0.0",
12764     "filename": "server/api/intFreshdeskField/index.js",
12765     "groupTitle": "Freshdesk_Fields"
12766   },
12767   {
12768     "type": "get",
12769     "url": "/api/integrations/freshdesk/fields",
12770     "title": "Gets a list of Freshdesk Fields",
12771     "examples": [
12772       {
12773         "title": "Example usage:",
12774         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12775         "type": "json"
12776       }
12777     ],
12778     "name": "GetFreshdesk_Fields",
12779     "group": "Freshdesk_Fields",
12780     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12781     "version": "0.0.0",
12782     "filename": "server/api/intFreshdeskField/index.js",
12783     "groupTitle": "Freshdesk_Fields"
12784   },
12785   {
12786     "type": "get",
12787     "url": "/api/integrations/freshdesk/fields/{id}",
12788     "title": "Gets a single Freshdesk Field",
12789     "examples": [
12790       {
12791         "title": "Example usage:",
12792         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12793         "type": "json"
12794       }
12795     ],
12796     "name": "ShowFreshdesk_Fields",
12797     "group": "Freshdesk_Fields",
12798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12799     "version": "0.0.0",
12800     "filename": "server/api/intFreshdeskField/index.js",
12801     "groupTitle": "Freshdesk_Fields"
12802   },
12803   {
12804     "type": "put",
12805     "url": "/api/integrations/freshdesk/fields/{id}",
12806     "title": "Update an existing Freshdesk Field",
12807     "examples": [
12808       {
12809         "title": "Example usage:",
12810         "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",
12811         "type": "json"
12812       }
12813     ],
12814     "name": "updateFreshdesk_Fields",
12815     "group": "Freshdesk_Fields",
12816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12817     "version": "0.0.0",
12818     "filename": "server/api/intFreshdeskField/index.js",
12819     "groupTitle": "Freshdesk_Fields"
12820   },
12821   {
12822     "type": "post",
12823     "url": "/api/integrations/freshsales/accounts",
12824     "title": "Creates a new Freshsales Account",
12825     "examples": [
12826       {
12827         "title": "Example usage:",
12828         "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",
12829         "type": "json"
12830       }
12831     ],
12832     "name": "CreateFreshsales_Accounts",
12833     "group": "Freshsales_Accounts",
12834     "parameter": {
12835       "fields": {
12836         "Body": [
12837           {
12838             "group": "Body",
12839             "type": "String",
12840             "optional": true,
12841             "field": "name",
12842             "description": ""
12843           },
12844           {
12845             "group": "Body",
12846             "type": "String",
12847             "optional": true,
12848             "field": "description",
12849             "description": ""
12850           },
12851           {
12852             "group": "Body",
12853             "type": "String",
12854             "optional": true,
12855             "field": "username",
12856             "description": ""
12857           },
12858           {
12859             "group": "Body",
12860             "type": "String",
12861             "optional": true,
12862             "field": "apiKey",
12863             "description": ""
12864           },
12865           {
12866             "group": "Body",
12867             "type": "String",
12868             "optional": true,
12869             "field": "remoteUri",
12870             "description": ""
12871           },
12872           {
12873             "group": "Body",
12874             "type": "String",
12875             "optional": false,
12876             "field": "serverUrl",
12877             "description": ""
12878           }
12879         ]
12880       }
12881     },
12882     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12883     "version": "0.0.0",
12884     "filename": "server/api/intFreshsalesAccount/index.js",
12885     "groupTitle": "Freshsales_Accounts"
12886   },
12887   {
12888     "type": "delete",
12889     "url": "/api/integrations/freshsales/accounts/{id}",
12890     "title": "Deletes a Freshsales Account",
12891     "examples": [
12892       {
12893         "title": "Example usage:",
12894         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12895         "type": "json"
12896       }
12897     ],
12898     "name": "DeleteFreshsales_Accounts",
12899     "group": "Freshsales_Accounts",
12900     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12901     "version": "0.0.0",
12902     "filename": "server/api/intFreshsalesAccount/index.js",
12903     "groupTitle": "Freshsales_Accounts"
12904   },
12905   {
12906     "type": "get",
12907     "url": "/api/integrations/freshsales/accounts",
12908     "title": "Gets a list of Freshsales Accounts",
12909     "examples": [
12910       {
12911         "title": "Example usage:",
12912         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12913         "type": "json"
12914       }
12915     ],
12916     "name": "GetFreshsales_Accounts",
12917     "group": "Freshsales_Accounts",
12918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12919     "version": "0.0.0",
12920     "filename": "server/api/intFreshsalesAccount/index.js",
12921     "groupTitle": "Freshsales_Accounts"
12922   },
12923   {
12924     "type": "get",
12925     "url": "/api/integrations/freshsales/accounts/{id}",
12926     "title": "Gets a single Freshsales Account",
12927     "examples": [
12928       {
12929         "title": "Example usage:",
12930         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12931         "type": "json"
12932       }
12933     ],
12934     "name": "ShowFreshsales_Accounts",
12935     "group": "Freshsales_Accounts",
12936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12937     "version": "0.0.0",
12938     "filename": "server/api/intFreshsalesAccount/index.js",
12939     "groupTitle": "Freshsales_Accounts"
12940   },
12941   {
12942     "type": "post",
12943     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12944     "title": "Creates new configuration",
12945     "examples": [
12946       {
12947         "title": "Example usage:",
12948         "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",
12949         "type": "json"
12950       }
12951     ],
12952     "name": "addConfiguration",
12953     "group": "Freshsales_Accounts",
12954     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12955     "version": "0.0.0",
12956     "filename": "server/api/intFreshsalesAccount/index.js",
12957     "groupTitle": "Freshsales_Accounts"
12958   },
12959   {
12960     "type": "get",
12961     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12962     "title": "Gets account configurations",
12963     "examples": [
12964       {
12965         "title": "Example usage:",
12966         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12967         "type": "json"
12968       }
12969     ],
12970     "name": "getConfigurations",
12971     "group": "Freshsales_Accounts",
12972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12973     "version": "0.0.0",
12974     "filename": "server/api/intFreshsalesAccount/index.js",
12975     "groupTitle": "Freshsales_Accounts"
12976   },
12977   {
12978     "type": "get",
12979     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12980     "title": "Gets account fields",
12981     "examples": [
12982       {
12983         "title": "Example usage:",
12984         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12985         "type": "json"
12986       }
12987     ],
12988     "name": "getFields",
12989     "group": "Freshsales_Accounts",
12990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12991     "version": "0.0.0",
12992     "filename": "server/api/intFreshsalesAccount/index.js",
12993     "groupTitle": "Freshsales_Accounts"
12994   },
12995   {
12996     "type": "put",
12997     "url": "/api/integrations/freshsales/accounts/{id}",
12998     "title": "Update an existing Freshsales Account",
12999     "examples": [
13000       {
13001         "title": "Example usage:",
13002         "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",
13003         "type": "json"
13004       }
13005     ],
13006     "name": "updateFreshsales_Accounts",
13007     "group": "Freshsales_Accounts",
13008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13009     "version": "0.0.0",
13010     "filename": "server/api/intFreshsalesAccount/index.js",
13011     "groupTitle": "Freshsales_Accounts"
13012   },
13013   {
13014     "type": "post",
13015     "url": "/api/integrations/freshsales/configurations",
13016     "title": "Creates a new Freshsales Configuration",
13017     "examples": [
13018       {
13019         "title": "Example usage:",
13020         "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",
13021         "type": "json"
13022       }
13023     ],
13024     "name": "CreateFreshsales_Configurations",
13025     "group": "Freshsales_Configurations",
13026     "parameter": {
13027       "fields": {
13028         "Body": [
13029           {
13030             "group": "Body",
13031             "type": "String",
13032             "optional": true,
13033             "field": "name",
13034             "description": ""
13035           },
13036           {
13037             "group": "Body",
13038             "type": "String",
13039             "optional": true,
13040             "field": "description",
13041             "description": ""
13042           }
13043         ]
13044       }
13045     },
13046     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13047     "version": "0.0.0",
13048     "filename": "server/api/intFreshsalesConfiguration/index.js",
13049     "groupTitle": "Freshsales_Configurations"
13050   },
13051   {
13052     "type": "delete",
13053     "url": "/api/integrations/freshsales/configurations/{id}",
13054     "title": "Deletes a Freshsales Configuration",
13055     "examples": [
13056       {
13057         "title": "Example usage:",
13058         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
13059         "type": "json"
13060       }
13061     ],
13062     "name": "DeleteFreshsales_Configurations",
13063     "group": "Freshsales_Configurations",
13064     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13065     "version": "0.0.0",
13066     "filename": "server/api/intFreshsalesConfiguration/index.js",
13067     "groupTitle": "Freshsales_Configurations"
13068   },
13069   {
13070     "type": "get",
13071     "url": "/api/integrations/freshsales/configurations",
13072     "title": "Gets a list of Freshsales Configurations",
13073     "examples": [
13074       {
13075         "title": "Example usage:",
13076         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
13077         "type": "json"
13078       }
13079     ],
13080     "name": "GetFreshsales_Configurations",
13081     "group": "Freshsales_Configurations",
13082     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13083     "version": "0.0.0",
13084     "filename": "server/api/intFreshsalesConfiguration/index.js",
13085     "groupTitle": "Freshsales_Configurations"
13086   },
13087   {
13088     "type": "get",
13089     "url": "/api/integrations/freshsales/configurations/{id}",
13090     "title": "Gets a single Freshsales Configuration",
13091     "examples": [
13092       {
13093         "title": "Example usage:",
13094         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
13095         "type": "json"
13096       }
13097     ],
13098     "name": "ShowFreshsales_Configurations",
13099     "group": "Freshsales_Configurations",
13100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13101     "version": "0.0.0",
13102     "filename": "server/api/intFreshsalesConfiguration/index.js",
13103     "groupTitle": "Freshsales_Configurations"
13104   },
13105   {
13106     "type": "get",
13107     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
13108     "title": "Gets configurations descriptions",
13109     "examples": [
13110       {
13111         "title": "Example usage:",
13112         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
13113         "type": "json"
13114       }
13115     ],
13116     "name": "getDescriptions",
13117     "group": "Freshsales_Configurations",
13118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13119     "version": "0.0.0",
13120     "filename": "server/api/intFreshsalesConfiguration/index.js",
13121     "groupTitle": "Freshsales_Configurations"
13122   },
13123   {
13124     "type": "get",
13125     "url": "/api/integrations/freshsales/configurations/{id}/fields",
13126     "title": "Gets configurations fields",
13127     "examples": [
13128       {
13129         "title": "Example usage:",
13130         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
13131         "type": "json"
13132       }
13133     ],
13134     "name": "getFields",
13135     "group": "Freshsales_Configurations",
13136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13137     "version": "0.0.0",
13138     "filename": "server/api/intFreshsalesConfiguration/index.js",
13139     "groupTitle": "Freshsales_Configurations"
13140   },
13141   {
13142     "type": "get",
13143     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
13144     "title": "Gets configurations subjects",
13145     "examples": [
13146       {
13147         "title": "Example usage:",
13148         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
13149         "type": "json"
13150       }
13151     ],
13152     "name": "getSubjects",
13153     "group": "Freshsales_Configurations",
13154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13155     "version": "0.0.0",
13156     "filename": "server/api/intFreshsalesConfiguration/index.js",
13157     "groupTitle": "Freshsales_Configurations"
13158   },
13159   {
13160     "type": "put",
13161     "url": "/api/integrations/freshsales/configurations/{id}",
13162     "title": "Update an existing Freshsales Configuration",
13163     "examples": [
13164       {
13165         "title": "Example usage:",
13166         "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",
13167         "type": "json"
13168       }
13169     ],
13170     "name": "updateFreshsales_Configurations",
13171     "group": "Freshsales_Configurations",
13172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13173     "version": "0.0.0",
13174     "filename": "server/api/intFreshsalesConfiguration/index.js",
13175     "groupTitle": "Freshsales_Configurations"
13176   },
13177   {
13178     "type": "post",
13179     "url": "/api/integrations/freshsales/fields",
13180     "title": "Creates a new Freshsales Field",
13181     "examples": [
13182       {
13183         "title": "Example usage:",
13184         "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",
13185         "type": "json"
13186       }
13187     ],
13188     "name": "CreateFreshsales_Fields",
13189     "group": "Freshsales_Fields",
13190     "parameter": {
13191       "fields": {
13192         "Body": [
13193           {
13194             "group": "Body",
13195             "type": "String",
13196             "allowedValues": [
13197               "\"string\"",
13198               "\"variable\"",
13199               "\"customVariable\"",
13200               "\"keyValue\"",
13201               "\"picklist\""
13202             ],
13203             "optional": true,
13204             "field": "type",
13205             "description": ""
13206           },
13207           {
13208             "group": "Body",
13209             "type": "String",
13210             "optional": true,
13211             "field": "content",
13212             "description": ""
13213           },
13214           {
13215             "group": "Body",
13216             "type": "String",
13217             "optional": true,
13218             "field": "key",
13219             "description": ""
13220           },
13221           {
13222             "group": "Body",
13223             "type": "String",
13224             "allowedValues": [
13225               "\"string\"",
13226               "\"variable\"",
13227               "\"customVariable\""
13228             ],
13229             "optional": true,
13230             "field": "keyType",
13231             "description": ""
13232           },
13233           {
13234             "group": "Body",
13235             "type": "String",
13236             "optional": true,
13237             "field": "keyContent",
13238             "description": ""
13239           },
13240           {
13241             "group": "Body",
13242             "type": "String",
13243             "optional": true,
13244             "field": "idField",
13245             "description": ""
13246           },
13247           {
13248             "group": "Body",
13249             "type": "String",
13250             "optional": true,
13251             "field": "nameField",
13252             "description": ""
13253           },
13254           {
13255             "group": "Body",
13256             "type": "Boolean",
13257             "optional": true,
13258             "field": "customField",
13259             "description": ""
13260           },
13261           {
13262             "group": "Body",
13263             "type": "String",
13264             "optional": true,
13265             "field": "variableName",
13266             "description": ""
13267           }
13268         ]
13269       }
13270     },
13271     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13272     "version": "0.0.0",
13273     "filename": "server/api/intFreshsalesField/index.js",
13274     "groupTitle": "Freshsales_Fields"
13275   },
13276   {
13277     "type": "delete",
13278     "url": "/api/integrations/freshsales/fields/{id}",
13279     "title": "Deletes a Freshsales Field",
13280     "examples": [
13281       {
13282         "title": "Example usage:",
13283         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13284         "type": "json"
13285       }
13286     ],
13287     "name": "DeleteFreshsales_Fields",
13288     "group": "Freshsales_Fields",
13289     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13290     "version": "0.0.0",
13291     "filename": "server/api/intFreshsalesField/index.js",
13292     "groupTitle": "Freshsales_Fields"
13293   },
13294   {
13295     "type": "get",
13296     "url": "/api/integrations/freshsales/fields",
13297     "title": "Gets a list of Freshsales Fields",
13298     "examples": [
13299       {
13300         "title": "Example usage:",
13301         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13302         "type": "json"
13303       }
13304     ],
13305     "name": "GetFreshsales_Fields",
13306     "group": "Freshsales_Fields",
13307     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13308     "version": "0.0.0",
13309     "filename": "server/api/intFreshsalesField/index.js",
13310     "groupTitle": "Freshsales_Fields"
13311   },
13312   {
13313     "type": "get",
13314     "url": "/api/integrations/freshsales/fields/{id}",
13315     "title": "Gets a single Freshsales Field",
13316     "examples": [
13317       {
13318         "title": "Example usage:",
13319         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13320         "type": "json"
13321       }
13322     ],
13323     "name": "ShowFreshsales_Fields",
13324     "group": "Freshsales_Fields",
13325     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13326     "version": "0.0.0",
13327     "filename": "server/api/intFreshsalesField/index.js",
13328     "groupTitle": "Freshsales_Fields"
13329   },
13330   {
13331     "type": "put",
13332     "url": "/api/integrations/freshsales/fields/{id}",
13333     "title": "Update an existing Freshsales Field",
13334     "examples": [
13335       {
13336         "title": "Example usage:",
13337         "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",
13338         "type": "json"
13339       }
13340     ],
13341     "name": "updateFreshsales_Fields",
13342     "group": "Freshsales_Fields",
13343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13344     "version": "0.0.0",
13345     "filename": "server/api/intFreshsalesField/index.js",
13346     "groupTitle": "Freshsales_Fields"
13347   },
13348   {
13349     "type": "post",
13350     "url": "/api/campaigns/{id}/blacklists",
13351     "title": "Add blacklists to an IVR campaign",
13352     "examples": [
13353       {
13354         "title": "Example usage:",
13355         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13356         "type": "json"
13357       }
13358     ],
13359     "name": "AddBlackLists",
13360     "group": "IVR_Campaigns",
13361     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13362     "version": "0.0.0",
13363     "filename": "server/api/campaign/index.js",
13364     "groupTitle": "IVR_Campaigns"
13365   },
13366   {
13367     "type": "post",
13368     "url": "/api/campaigns/{id}/lists",
13369     "title": "Add lists to an IVR campaign",
13370     "examples": [
13371       {
13372         "title": "Example usage:",
13373         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13374         "type": "json"
13375       }
13376     ],
13377     "name": "AddLists",
13378     "group": "IVR_Campaigns",
13379     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13380     "version": "0.0.0",
13381     "filename": "server/api/campaign/index.js",
13382     "groupTitle": "IVR_Campaigns"
13383   },
13384   {
13385     "type": "post",
13386     "url": "/api/campaigns/clone",
13387     "title": "Clone an existing IVR Campaign",
13388     "examples": [
13389       {
13390         "title": "Example usage:",
13391         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13392         "type": "json"
13393       }
13394     ],
13395     "name": "CloneIVR_Campaigns",
13396     "group": "IVR_Campaigns",
13397     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13398     "version": "0.0.0",
13399     "filename": "server/api/campaign/index.js",
13400     "groupTitle": "IVR_Campaigns"
13401   },
13402   {
13403     "type": "post",
13404     "url": "/api/campaigns",
13405     "title": "Creates a new IVR Campaign",
13406     "examples": [
13407       {
13408         "title": "Example usage:",
13409         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13410         "type": "json"
13411       }
13412     ],
13413     "name": "CreateIVR_Campaigns",
13414     "group": "IVR_Campaigns",
13415     "parameter": {
13416       "fields": {
13417         "Body": [
13418           {
13419             "group": "Body",
13420             "type": "String",
13421             "optional": false,
13422             "field": "name",
13423             "description": ""
13424           },
13425           {
13426             "group": "Body",
13427             "type": "String",
13428             "allowedValues": [
13429               "\"ivr\""
13430             ],
13431             "optional": false,
13432             "field": "type",
13433             "description": ""
13434           },
13435           {
13436             "group": "Body",
13437             "type": "String",
13438             "optional": true,
13439             "field": "description",
13440             "description": ""
13441           },
13442           {
13443             "group": "Body",
13444             "type": "Boolean",
13445             "optional": true,
13446             "field": "active",
13447             "description": "<p>Active/Disactive Campaign</p>"
13448           },
13449           {
13450             "group": "Body",
13451             "type": "Integer",
13452             "optional": true,
13453             "field": "limitCalls",
13454             "description": "<p>Max 200 calls.</p>"
13455           },
13456           {
13457             "group": "Body",
13458             "type": "String",
13459             "optional": true,
13460             "field": "dialOriginateCallerIdName",
13461             "description": ""
13462           },
13463           {
13464             "group": "Body",
13465             "type": "String",
13466             "optional": true,
13467             "field": "dialOriginateCallerIdNumber",
13468             "description": ""
13469           },
13470           {
13471             "group": "Body",
13472             "type": "Integer",
13473             "optional": true,
13474             "field": "dialOriginateTimeout",
13475             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13476           },
13477           {
13478             "group": "Body",
13479             "type": "Integer",
13480             "optional": true,
13481             "field": "dialCongestionMaxRetry",
13482             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13483           },
13484           {
13485             "group": "Body",
13486             "type": "Integer",
13487             "optional": true,
13488             "field": "dialCongestionRetryFrequency",
13489             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13490           },
13491           {
13492             "group": "Body",
13493             "type": "Integer",
13494             "optional": true,
13495             "field": "dialBusyMaxRetry",
13496             "description": "<p>#Busy Retry (min:1, max:999)</p>"
13497           },
13498           {
13499             "group": "Body",
13500             "type": "Integer",
13501             "optional": true,
13502             "field": "dialBusyRetryFrequency",
13503             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13504           },
13505           {
13506             "group": "Body",
13507             "type": "Integer",
13508             "optional": true,
13509             "field": "dialNoAnswerMaxRetry",
13510             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13511           },
13512           {
13513             "group": "Body",
13514             "type": "Integer",
13515             "optional": true,
13516             "field": "dialNoAnswerRetryFrequency",
13517             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13518           },
13519           {
13520             "group": "Body",
13521             "type": "Integer",
13522             "optional": true,
13523             "field": "dialGlobalMaxRetry",
13524             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13525           },
13526           {
13527             "group": "Body",
13528             "type": "String",
13529             "optional": true,
13530             "field": "dialTimezone",
13531             "description": ""
13532           },
13533           {
13534             "group": "Body",
13535             "type": "String",
13536             "optional": true,
13537             "field": "dialGlobalInterval",
13538             "description": ""
13539           },
13540           {
13541             "group": "Body",
13542             "type": "String",
13543             "allowedValues": [
13544               "\"always\"",
13545               "\"never\"",
13546               "\"onlyIfOpen\""
13547             ],
13548             "optional": true,
13549             "field": "dialCheckDuplicateType",
13550             "description": ""
13551           },
13552           {
13553             "group": "Body",
13554             "type": "Boolean",
13555             "optional": true,
13556             "field": "dialAMDActive",
13557             "description": "<p>Active/Disactive AMD</p>"
13558           },
13559           {
13560             "group": "Body",
13561             "type": "Integer",
13562             "optional": true,
13563             "field": "dialAMDInitialSilence",
13564             "description": "<p>#AMD Initial Silence</p>"
13565           },
13566           {
13567             "group": "Body",
13568             "type": "Integer",
13569             "optional": true,
13570             "field": "dialAMDGreeting",
13571             "description": "<p>#AMD Greeting</p>"
13572           },
13573           {
13574             "group": "Body",
13575             "type": "Integer",
13576             "optional": true,
13577             "field": "dialAMDAfterGreetingSilence",
13578             "description": "<p>#AMD After Greeting Silence</p>"
13579           },
13580           {
13581             "group": "Body",
13582             "type": "Integer",
13583             "optional": true,
13584             "field": "dialAMDTotalAnalysisTime",
13585             "description": "<p>#AMD Total Analysis Time</p>"
13586           },
13587           {
13588             "group": "Body",
13589             "type": "Integer",
13590             "optional": true,
13591             "field": "dialAMDMinWordLength",
13592             "description": "<p>#AMD Min Word Length</p>"
13593           },
13594           {
13595             "group": "Body",
13596             "type": "Integer",
13597             "optional": true,
13598             "field": "dialAMDBetweenWordsSilence",
13599             "description": "<p>#AMD Between Words Silence</p>"
13600           },
13601           {
13602             "group": "Body",
13603             "type": "Integer",
13604             "optional": true,
13605             "field": "dialAMDMaximumNumberOfWords",
13606             "description": "<p>#AMD Maximum Number Of Words</p>"
13607           },
13608           {
13609             "group": "Body",
13610             "type": "Integer",
13611             "optional": true,
13612             "field": "dialAMDSilenceThreshold",
13613             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13614           },
13615           {
13616             "group": "Body",
13617             "type": "Integer",
13618             "optional": true,
13619             "field": "dialAMDMaximumWordLength",
13620             "description": "<p>#AMD Maximum Word Length</p>"
13621           },
13622           {
13623             "group": "Body",
13624             "type": "String",
13625             "allowedValues": [
13626               "\"DESC\"",
13627               "\"ASC\""
13628             ],
13629             "optional": true,
13630             "field": "dialOrderByScheduledAt",
13631             "description": ""
13632           },
13633           {
13634             "group": "Body",
13635             "type": "String",
13636             "optional": true,
13637             "field": "dialPrefix",
13638             "description": ""
13639           },
13640           {
13641             "group": "Body",
13642             "type": "Integer",
13643             "optional": true,
13644             "field": "dialRandomLastDigitCallerIdNumber",
13645             "description": "<p>Random Last Digit (min:1, max:15)</p>"
13646           },
13647           {
13648             "group": "Body",
13649             "type": "Integer",
13650             "optional": true,
13651             "field": "dialCutDigit",
13652             "description": "<p>Cut Digit (min:1, max:15)</p>"
13653           },
13654           {
13655             "group": "Body",
13656             "type": "Integer",
13657             "optional": true,
13658             "field": "dialNoSuchNumberMaxRetry",
13659             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13660           },
13661           {
13662             "group": "Body",
13663             "type": "Integer",
13664             "optional": true,
13665             "field": "dialNoSuchNumberRetryFrequency",
13666             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13667           },
13668           {
13669             "group": "Body",
13670             "type": "Integer",
13671             "optional": true,
13672             "field": "dialDropMaxRetry",
13673             "description": "<p>#Drop Retry (min:1, max:999)</p>"
13674           },
13675           {
13676             "group": "Body",
13677             "type": "Integer",
13678             "optional": true,
13679             "field": "dialDropRetryFrequency",
13680             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13681           },
13682           {
13683             "group": "Body",
13684             "type": "Integer",
13685             "optional": true,
13686             "field": "dialAbandonedMaxRetry",
13687             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13688           },
13689           {
13690             "group": "Body",
13691             "type": "Integer",
13692             "optional": true,
13693             "field": "dialAbandonedRetryFrequency",
13694             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13695           },
13696           {
13697             "group": "Body",
13698             "type": "Integer",
13699             "optional": true,
13700             "field": "dialMachineMaxRetry",
13701             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13702           },
13703           {
13704             "group": "Body",
13705             "type": "Integer",
13706             "optional": true,
13707             "field": "dialMachineRetryFrequency",
13708             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13709           },
13710           {
13711             "group": "Body",
13712             "type": "Integer",
13713             "optional": true,
13714             "field": "dialAgentRejectMaxRetry",
13715             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13716           },
13717           {
13718             "group": "Body",
13719             "type": "Integer",
13720             "optional": true,
13721             "field": "dialAgentRejectRetryFrequency",
13722             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13723           }
13724         ]
13725       }
13726     },
13727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13728     "version": "0.0.0",
13729     "filename": "server/api/campaign/index.js",
13730     "groupTitle": "IVR_Campaigns"
13731   },
13732   {
13733     "type": "delete",
13734     "url": "/api/campaigns/{id}",
13735     "title": "Deletes a IVR Campaign",
13736     "examples": [
13737       {
13738         "title": "Example usage:",
13739         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13740         "type": "json"
13741       }
13742     ],
13743     "name": "DeleteIVR_Campaigns",
13744     "group": "IVR_Campaigns",
13745     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13746     "version": "0.0.0",
13747     "filename": "server/api/campaign/index.js",
13748     "groupTitle": "IVR_Campaigns"
13749   },
13750   {
13751     "type": "get",
13752     "url": "/api/campaigns/{id}/blacklists",
13753     "title": "Get IVR campaign blacklists",
13754     "examples": [
13755       {
13756         "title": "Example usage:",
13757         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13758         "type": "json"
13759       }
13760     ],
13761     "name": "GetBlackLists",
13762     "group": "IVR_Campaigns",
13763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13764     "version": "0.0.0",
13765     "filename": "server/api/campaign/index.js",
13766     "groupTitle": "IVR_Campaigns"
13767   },
13768   {
13769     "type": "get",
13770     "url": "/api/campaigns/{id}/finals",
13771     "title": "Gets IVR campaign hopper finals",
13772     "examples": [
13773       {
13774         "title": "Example usage:",
13775         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13776         "type": "json"
13777       }
13778     ],
13779     "name": "GetHopperFinals",
13780     "group": "IVR_Campaigns",
13781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13782     "version": "0.0.0",
13783     "filename": "server/api/campaign/index.js",
13784     "groupTitle": "IVR_Campaigns"
13785   },
13786   {
13787     "type": "get",
13788     "url": "/api/campaigns/{id}/hopper_histories",
13789     "title": "Gets IVR campaign hopper histories",
13790     "examples": [
13791       {
13792         "title": "Example usage:",
13793         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13794         "type": "json"
13795       }
13796     ],
13797     "name": "GetHopperHistories",
13798     "group": "IVR_Campaigns",
13799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13800     "version": "0.0.0",
13801     "filename": "server/api/campaign/index.js",
13802     "groupTitle": "IVR_Campaigns"
13803   },
13804   {
13805     "type": "get",
13806     "url": "/api/campaigns/{id}/hoppers",
13807     "title": "Gets IVR campaign hoppers",
13808     "examples": [
13809       {
13810         "title": "Example usage:",
13811         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13812         "type": "json"
13813       }
13814     ],
13815     "name": "GetHoppers",
13816     "group": "IVR_Campaigns",
13817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13818     "version": "0.0.0",
13819     "filename": "server/api/campaign/index.js",
13820     "groupTitle": "IVR_Campaigns"
13821   },
13822   {
13823     "type": "get",
13824     "url": "/api/campaigns",
13825     "title": "Gets a list of IVR Campaigns",
13826     "examples": [
13827       {
13828         "title": "Example usage:",
13829         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13830         "type": "json"
13831       }
13832     ],
13833     "name": "GetIVR_Campaigns",
13834     "group": "IVR_Campaigns",
13835     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13836     "version": "0.0.0",
13837     "filename": "server/api/campaign/index.js",
13838     "groupTitle": "IVR_Campaigns"
13839   },
13840   {
13841     "type": "get",
13842     "url": "/api/campaigns/{id}/lists",
13843     "title": "Get IVR campaign lists",
13844     "examples": [
13845       {
13846         "title": "Example usage:",
13847         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13848         "type": "json"
13849       }
13850     ],
13851     "name": "GetLists",
13852     "group": "IVR_Campaigns",
13853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13854     "version": "0.0.0",
13855     "filename": "server/api/campaign/index.js",
13856     "groupTitle": "IVR_Campaigns"
13857   },
13858   {
13859     "type": "delete",
13860     "url": "/api/campaigns/{id}/blacklists",
13861     "title": "Remove blacklists from an IVR Campaign",
13862     "examples": [
13863       {
13864         "title": "Example usage:",
13865         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13866         "type": "json"
13867       }
13868     ],
13869     "name": "RemoveBlackLists",
13870     "group": "IVR_Campaigns",
13871     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13872     "version": "0.0.0",
13873     "filename": "server/api/campaign/index.js",
13874     "groupTitle": "IVR_Campaigns"
13875   },
13876   {
13877     "type": "delete",
13878     "url": "/api/campaigns/{id}/lists",
13879     "title": "Remove lists from an IVR Campaign",
13880     "examples": [
13881       {
13882         "title": "Example usage:",
13883         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13884         "type": "json"
13885       }
13886     ],
13887     "name": "RemoveLists",
13888     "group": "IVR_Campaigns",
13889     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13890     "version": "0.0.0",
13891     "filename": "server/api/campaign/index.js",
13892     "groupTitle": "IVR_Campaigns"
13893   },
13894   {
13895     "type": "get",
13896     "url": "/api/campaigns/{id}",
13897     "title": "Gets a single IVR Campaign",
13898     "examples": [
13899       {
13900         "title": "Example usage:",
13901         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13902         "type": "json"
13903       }
13904     ],
13905     "name": "ShowIVR_Campaigns",
13906     "group": "IVR_Campaigns",
13907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13908     "version": "0.0.0",
13909     "filename": "server/api/campaign/index.js",
13910     "groupTitle": "IVR_Campaigns"
13911   },
13912   {
13913     "type": "get",
13914     "url": "/api/campaigns/{id}/blacks",
13915     "title": "Gets IVR campaign hopper blacks",
13916     "examples": [
13917       {
13918         "title": "Example usage:",
13919         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13920         "type": "json"
13921       }
13922     ],
13923     "name": "getHopperBlacks",
13924     "group": "IVR_Campaigns",
13925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13926     "version": "0.0.0",
13927     "filename": "server/api/campaign/index.js",
13928     "groupTitle": "IVR_Campaigns"
13929   },
13930   {
13931     "type": "put",
13932     "url": "/api/campaigns/{id}",
13933     "title": "Update an existing IVR Campaign",
13934     "examples": [
13935       {
13936         "title": "Example usage:",
13937         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13938         "type": "json"
13939       }
13940     ],
13941     "name": "updateIVR_Campaigns",
13942     "group": "IVR_Campaigns",
13943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13944     "version": "0.0.0",
13945     "filename": "server/api/campaign/index.js",
13946     "groupTitle": "IVR_Campaigns"
13947   },
13948   {
13949     "type": "post",
13950     "url": "/api/integrations/reports",
13951     "title": "Creates a new Integration Report",
13952     "examples": [
13953       {
13954         "title": "Example usage:",
13955         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13956         "type": "json"
13957       }
13958     ],
13959     "name": "CreateIntegration_Reports",
13960     "group": "Integration_Reports",
13961     "parameter": {
13962       "fields": {
13963         "Body": [
13964           {
13965             "group": "Body",
13966             "type": "String",
13967             "optional": true,
13968             "field": "integration",
13969             "description": ""
13970           },
13971           {
13972             "group": "Body",
13973             "type": "String",
13974             "optional": true,
13975             "field": "eventChannel",
13976             "description": ""
13977           },
13978           {
13979             "group": "Body",
13980             "type": "String",
13981             "optional": true,
13982             "field": "exitStatus",
13983             "description": ""
13984           },
13985           {
13986             "group": "Body",
13987             "type": "String",
13988             "optional": true,
13989             "field": "ticketId",
13990             "description": ""
13991           },
13992           {
13993             "group": "Body",
13994             "type": "Integer",
13995             "optional": true,
13996             "field": "integrationId",
13997             "description": ""
13998           },
13999           {
14000             "group": "Body",
14001             "type": "String",
14002             "optional": true,
14003             "field": "contacts",
14004             "description": ""
14005           },
14006           {
14007             "group": "Body",
14008             "type": "String",
14009             "optional": true,
14010             "field": "uniqueid",
14011             "description": ""
14012           },
14013           {
14014             "group": "Body",
14015             "type": "String",
14016             "optional": true,
14017             "field": "calleridnum",
14018             "description": ""
14019           },
14020           {
14021             "group": "Body",
14022             "type": "String",
14023             "optional": true,
14024             "field": "calleridname",
14025             "description": ""
14026           },
14027           {
14028             "group": "Body",
14029             "type": "String",
14030             "optional": true,
14031             "field": "queue",
14032             "description": ""
14033           },
14034           {
14035             "group": "Body",
14036             "type": "String",
14037             "optional": true,
14038             "field": "interface",
14039             "description": ""
14040           },
14041           {
14042             "group": "Body",
14043             "type": "String",
14044             "optional": true,
14045             "field": "membername",
14046             "description": ""
14047           },
14048           {
14049             "group": "Body",
14050             "type": "String",
14051             "optional": true,
14052             "field": "agentcalledAt",
14053             "description": ""
14054           },
14055           {
14056             "group": "Body",
14057             "type": "String",
14058             "optional": true,
14059             "field": "agentconnectAt",
14060             "description": ""
14061           },
14062           {
14063             "group": "Body",
14064             "type": "Integer",
14065             "optional": true,
14066             "field": "holdtime",
14067             "description": ""
14068           },
14069           {
14070             "group": "Body",
14071             "type": "Boolean",
14072             "optional": true,
14073             "field": "agentcomplete",
14074             "description": ""
14075           },
14076           {
14077             "group": "Body",
14078             "type": "String",
14079             "optional": true,
14080             "field": "agentcompleteAt",
14081             "description": ""
14082           },
14083           {
14084             "group": "Body",
14085             "type": "Integer",
14086             "optional": true,
14087             "field": "talktime",
14088             "description": ""
14089           },
14090           {
14091             "group": "Body",
14092             "type": "Boolean",
14093             "optional": true,
14094             "field": "agentacw",
14095             "description": ""
14096           },
14097           {
14098             "group": "Body",
14099             "type": "Integer",
14100             "optional": true,
14101             "field": "acwtime",
14102             "description": ""
14103           },
14104           {
14105             "group": "Body",
14106             "type": "String",
14107             "optional": true,
14108             "field": "reason",
14109             "description": ""
14110           },
14111           {
14112             "group": "Body",
14113             "type": "Boolean",
14114             "optional": true,
14115             "field": "agentringnoanswer",
14116             "description": ""
14117           },
14118           {
14119             "group": "Body",
14120             "type": "String",
14121             "optional": true,
14122             "field": "agentringnoanswerAt",
14123             "description": ""
14124           },
14125           {
14126             "group": "Body",
14127             "type": "Boolean",
14128             "optional": true,
14129             "field": "agentdump",
14130             "description": ""
14131           },
14132           {
14133             "group": "Body",
14134             "type": "String",
14135             "optional": true,
14136             "field": "agentdumpAt",
14137             "description": ""
14138           },
14139           {
14140             "group": "Body",
14141             "type": "String",
14142             "optional": true,
14143             "field": "lastevent",
14144             "description": ""
14145           },
14146           {
14147             "group": "Body",
14148             "type": "String",
14149             "optional": true,
14150             "field": "channel",
14151             "description": ""
14152           },
14153           {
14154             "group": "Body",
14155             "type": "Integer",
14156             "optional": true,
14157             "field": "channelstate",
14158             "description": ""
14159           },
14160           {
14161             "group": "Body",
14162             "type": "String",
14163             "optional": true,
14164             "field": "channelstatedesc",
14165             "description": ""
14166           },
14167           {
14168             "group": "Body",
14169             "type": "String",
14170             "optional": true,
14171             "field": "connectedlinenum",
14172             "description": ""
14173           },
14174           {
14175             "group": "Body",
14176             "type": "String",
14177             "optional": true,
14178             "field": "connectedlinename",
14179             "description": ""
14180           },
14181           {
14182             "group": "Body",
14183             "type": "String",
14184             "optional": true,
14185             "field": "language",
14186             "description": ""
14187           },
14188           {
14189             "group": "Body",
14190             "type": "String",
14191             "optional": true,
14192             "field": "accountcode",
14193             "description": ""
14194           },
14195           {
14196             "group": "Body",
14197             "type": "String",
14198             "optional": true,
14199             "field": "context",
14200             "description": ""
14201           },
14202           {
14203             "group": "Body",
14204             "type": "String",
14205             "optional": true,
14206             "field": "exten",
14207             "description": ""
14208           },
14209           {
14210             "group": "Body",
14211             "type": "String",
14212             "optional": true,
14213             "field": "priority",
14214             "description": ""
14215           },
14216           {
14217             "group": "Body",
14218             "type": "String",
14219             "optional": true,
14220             "field": "destchannel",
14221             "description": ""
14222           },
14223           {
14224             "group": "Body",
14225             "type": "Integer",
14226             "optional": true,
14227             "field": "destchannelstate",
14228             "description": ""
14229           },
14230           {
14231             "group": "Body",
14232             "type": "String",
14233             "optional": true,
14234             "field": "destchannelstatedesc",
14235             "description": ""
14236           },
14237           {
14238             "group": "Body",
14239             "type": "String",
14240             "optional": true,
14241             "field": "destcalleridnum",
14242             "description": ""
14243           },
14244           {
14245             "group": "Body",
14246             "type": "String",
14247             "optional": true,
14248             "field": "destcalleridname",
14249             "description": ""
14250           },
14251           {
14252             "group": "Body",
14253             "type": "String",
14254             "optional": true,
14255             "field": "destconnectedlinenum",
14256             "description": ""
14257           },
14258           {
14259             "group": "Body",
14260             "type": "String",
14261             "optional": true,
14262             "field": "destconnectedlinename",
14263             "description": ""
14264           },
14265           {
14266             "group": "Body",
14267             "type": "String",
14268             "optional": true,
14269             "field": "destlanguage",
14270             "description": ""
14271           },
14272           {
14273             "group": "Body",
14274             "type": "String",
14275             "optional": true,
14276             "field": "destaccountcode",
14277             "description": ""
14278           },
14279           {
14280             "group": "Body",
14281             "type": "String",
14282             "optional": true,
14283             "field": "destcontext",
14284             "description": ""
14285           },
14286           {
14287             "group": "Body",
14288             "type": "String",
14289             "optional": true,
14290             "field": "destexten",
14291             "description": ""
14292           },
14293           {
14294             "group": "Body",
14295             "type": "String",
14296             "optional": true,
14297             "field": "destpriority",
14298             "description": ""
14299           },
14300           {
14301             "group": "Body",
14302             "type": "String",
14303             "optional": true,
14304             "field": "destuniqueid",
14305             "description": ""
14306           },
14307           {
14308             "group": "Body",
14309             "type": "String",
14310             "optional": true,
14311             "field": "messageId",
14312             "description": ""
14313           },
14314           {
14315             "group": "Body",
14316             "type": "String",
14317             "optional": true,
14318             "field": "inReplyTo",
14319             "description": ""
14320           },
14321           {
14322             "group": "Body",
14323             "type": "String",
14324             "optional": true,
14325             "field": "subject",
14326             "description": ""
14327           },
14328           {
14329             "group": "Body",
14330             "type": "String",
14331             "optional": true,
14332             "field": "from",
14333             "description": ""
14334           },
14335           {
14336             "group": "Body",
14337             "type": "String",
14338             "optional": true,
14339             "field": "to",
14340             "description": ""
14341           },
14342           {
14343             "group": "Body",
14344             "type": "String",
14345             "optional": true,
14346             "field": "cc",
14347             "description": ""
14348           },
14349           {
14350             "group": "Body",
14351             "type": "Text",
14352             "optional": true,
14353             "field": "attachment",
14354             "description": ""
14355           },
14356           {
14357             "group": "Body",
14358             "type": "Text",
14359             "optional": true,
14360             "field": "html",
14361             "description": ""
14362           },
14363           {
14364             "group": "Body",
14365             "type": "Text",
14366             "optional": true,
14367             "field": "text",
14368             "description": ""
14369           },
14370           {
14371             "group": "Body",
14372             "type": "String",
14373             "allowedValues": [
14374               "\"SENT\"",
14375               "\"SENDING\"",
14376               "\"RECEIVED\"",
14377               "\"FAILED\""
14378             ],
14379             "optional": true,
14380             "field": "status",
14381             "description": ""
14382           },
14383           {
14384             "group": "Body",
14385             "type": "String",
14386             "optional": true,
14387             "field": "url",
14388             "description": ""
14389           },
14390           {
14391             "group": "Body",
14392             "type": "String",
14393             "optional": true,
14394             "field": "app",
14395             "description": ""
14396           },
14397           {
14398             "group": "Body",
14399             "type": "String",
14400             "optional": true,
14401             "field": "appdata",
14402             "description": ""
14403           },
14404           {
14405             "group": "Body",
14406             "type": "Integer",
14407             "optional": true,
14408             "field": "projectId",
14409             "description": ""
14410           }
14411         ]
14412       }
14413     },
14414     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14415     "version": "0.0.0",
14416     "filename": "server/api/integrationReport/index.js",
14417     "groupTitle": "Integration_Reports"
14418   },
14419   {
14420     "type": "delete",
14421     "url": "/api/integrations/reports/{id}",
14422     "title": "Deletes a Integration Report",
14423     "examples": [
14424       {
14425         "title": "Example usage:",
14426         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14427         "type": "json"
14428       }
14429     ],
14430     "name": "DeleteIntegration_Reports",
14431     "group": "Integration_Reports",
14432     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14433     "version": "0.0.0",
14434     "filename": "server/api/integrationReport/index.js",
14435     "groupTitle": "Integration_Reports"
14436   },
14437   {
14438     "type": "get",
14439     "url": "/api/integrations/reports/describe",
14440     "title": "Gets table info about Integration Reports",
14441     "examples": [
14442       {
14443         "title": "Example usage:",
14444         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14445         "type": "json"
14446       }
14447     ],
14448     "name": "DescribeIntegration_Reports",
14449     "group": "Integration_Reports",
14450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14451     "version": "0.0.0",
14452     "filename": "server/api/integrationReport/index.js",
14453     "groupTitle": "Integration_Reports"
14454   },
14455   {
14456     "type": "get",
14457     "url": "/api/integrations/reports",
14458     "title": "Gets a list of Integration Reports",
14459     "examples": [
14460       {
14461         "title": "Example usage:",
14462         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14463         "type": "json"
14464       }
14465     ],
14466     "name": "GetIntegration_Reports",
14467     "group": "Integration_Reports",
14468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14469     "version": "0.0.0",
14470     "filename": "server/api/integrationReport/index.js",
14471     "groupTitle": "Integration_Reports"
14472   },
14473   {
14474     "type": "get",
14475     "url": "/api/integrations/reports/{id}",
14476     "title": "Gets a single Integration Report",
14477     "examples": [
14478       {
14479         "title": "Example usage:",
14480         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14481         "type": "json"
14482       }
14483     ],
14484     "name": "ShowIntegration_Reports",
14485     "group": "Integration_Reports",
14486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14487     "version": "0.0.0",
14488     "filename": "server/api/integrationReport/index.js",
14489     "groupTitle": "Integration_Reports"
14490   },
14491   {
14492     "type": "put",
14493     "url": "/api/integrations/reports/{id}",
14494     "title": "Update an existing Integration Report",
14495     "examples": [
14496       {
14497         "title": "Example usage:",
14498         "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",
14499         "type": "json"
14500       }
14501     ],
14502     "name": "updateIntegration_Reports",
14503     "group": "Integration_Reports",
14504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14505     "version": "0.0.0",
14506     "filename": "server/api/integrationReport/index.js",
14507     "groupTitle": "Integration_Reports"
14508   },
14509   {
14510     "type": "post",
14511     "url": "/api/intervals",
14512     "title": "Creates a new Interval",
14513     "examples": [
14514       {
14515         "title": "Example usage:",
14516         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14517         "type": "json"
14518       }
14519     ],
14520     "name": "CreateIntervals",
14521     "group": "Intervals",
14522     "parameter": {
14523       "fields": {
14524         "Body": [
14525           {
14526             "group": "Body",
14527             "type": "String",
14528             "optional": true,
14529             "field": "name",
14530             "description": ""
14531           },
14532           {
14533             "group": "Body",
14534             "type": "String",
14535             "optional": true,
14536             "field": "description",
14537             "description": ""
14538           },
14539           {
14540             "group": "Body",
14541             "type": "String",
14542             "optional": true,
14543             "field": "interval",
14544             "description": ""
14545           }
14546         ]
14547       }
14548     },
14549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14550     "version": "0.0.0",
14551     "filename": "server/api/interval/index.js",
14552     "groupTitle": "Intervals"
14553   },
14554   {
14555     "type": "delete",
14556     "url": "/api/intervals/{id}",
14557     "title": "Deletes a Interval",
14558     "examples": [
14559       {
14560         "title": "Example usage:",
14561         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14562         "type": "json"
14563       }
14564     ],
14565     "name": "DeleteIntervals",
14566     "group": "Intervals",
14567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14568     "version": "0.0.0",
14569     "filename": "server/api/interval/index.js",
14570     "groupTitle": "Intervals"
14571   },
14572   {
14573     "type": "get",
14574     "url": "/api/intervals",
14575     "title": "Gets a list of Intervals",
14576     "examples": [
14577       {
14578         "title": "Example usage:",
14579         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14580         "type": "json"
14581       }
14582     ],
14583     "name": "GetIntervals",
14584     "group": "Intervals",
14585     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14586     "version": "0.0.0",
14587     "filename": "server/api/interval/index.js",
14588     "groupTitle": "Intervals"
14589   },
14590   {
14591     "type": "get",
14592     "url": "/api/intervals/{id}",
14593     "title": "Gets a single Interval",
14594     "examples": [
14595       {
14596         "title": "Example usage:",
14597         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14598         "type": "json"
14599       }
14600     ],
14601     "name": "ShowIntervals",
14602     "group": "Intervals",
14603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14604     "version": "0.0.0",
14605     "filename": "server/api/interval/index.js",
14606     "groupTitle": "Intervals"
14607   },
14608   {
14609     "type": "post",
14610     "url": "/api/intervals/{id}/sub_intervals",
14611     "title": "Creates a new sub interval",
14612     "examples": [
14613       {
14614         "title": "Example usage:",
14615         "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",
14616         "type": "json"
14617       }
14618     ],
14619     "name": "addInterval",
14620     "group": "Intervals",
14621     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14622     "version": "0.0.0",
14623     "filename": "server/api/interval/index.js",
14624     "groupTitle": "Intervals"
14625   },
14626   {
14627     "type": "post",
14628     "url": "/api/intervals/{id}/sub_intervals/create_many",
14629     "title": "Create new sub intervals set",
14630     "examples": [
14631       {
14632         "title": "Example usage:",
14633         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14634         "type": "json"
14635       }
14636     ],
14637     "name": "addIntervals",
14638     "group": "Intervals",
14639     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14640     "version": "0.0.0",
14641     "filename": "server/api/interval/index.js",
14642     "groupTitle": "Intervals"
14643   },
14644   {
14645     "type": "get",
14646     "url": "/api/intervals/{id}/sub_intervals",
14647     "title": "Get sub intervals set",
14648     "examples": [
14649       {
14650         "title": "Example usage:",
14651         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14652         "type": "json"
14653       }
14654     ],
14655     "name": "getIntervals",
14656     "group": "Intervals",
14657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14658     "version": "0.0.0",
14659     "filename": "server/api/interval/index.js",
14660     "groupTitle": "Intervals"
14661   },
14662   {
14663     "type": "put",
14664     "url": "/api/intervals/{id}",
14665     "title": "Update an existing Interval",
14666     "examples": [
14667       {
14668         "title": "Example usage:",
14669         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14670         "type": "json"
14671       }
14672     ],
14673     "name": "updateIntervals",
14674     "group": "Intervals",
14675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14676     "version": "0.0.0",
14677     "filename": "server/api/interval/index.js",
14678     "groupTitle": "Intervals"
14679   },
14680   {
14681     "type": "post",
14682     "url": "/api/jira",
14683     "title": "Creates a new issue",
14684     "examples": [
14685       {
14686         "title": "Example usage:",
14687         "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}",
14688         "type": "json"
14689       }
14690     ],
14691     "name": "Creates_Issue",
14692     "group": "Issue",
14693     "parameter": {
14694       "fields": {
14695         "Body": [
14696           {
14697             "group": "Body",
14698             "type": "String",
14699             "allowedValues": [
14700               "\"Bug\""
14701             ],
14702             "optional": true,
14703             "field": "issuetype",
14704             "description": ""
14705           },
14706           {
14707             "group": "Body",
14708             "type": "String",
14709             "optional": false,
14710             "field": "summary",
14711             "description": ""
14712           },
14713           {
14714             "group": "Body",
14715             "type": "String",
14716             "optional": false,
14717             "field": "description",
14718             "description": ""
14719           }
14720         ]
14721       }
14722     },
14723     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14724     "version": "0.0.0",
14725     "filename": "server/api/jira/index.js",
14726     "groupTitle": "Issue"
14727   },
14728   {
14729     "type": "post",
14730     "url": "/api/jscripty/answers/reports",
14731     "title": "Creates a new Report",
14732     "examples": [
14733       {
14734         "title": "Example usage:",
14735         "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",
14736         "type": "json"
14737       }
14738     ],
14739     "name": "CreateReports",
14740     "group": "JscriptyAnswerReport",
14741     "parameter": {
14742       "fields": {
14743         "Body": [
14744           {
14745             "group": "Body",
14746             "type": "Text",
14747             "optional": true,
14748             "field": "question",
14749             "description": ""
14750           },
14751           {
14752             "group": "Body",
14753             "type": "Text",
14754             "optional": true,
14755             "field": "answer",
14756             "description": ""
14757           },
14758           {
14759             "group": "Body",
14760             "type": "String",
14761             "optional": true,
14762             "field": "membername",
14763             "description": ""
14764           },
14765           {
14766             "group": "Body",
14767             "type": "String",
14768             "optional": true,
14769             "field": "projectname",
14770             "description": ""
14771           },
14772           {
14773             "group": "Body",
14774             "type": "String",
14775             "optional": true,
14776             "field": "queue",
14777             "description": ""
14778           },
14779           {
14780             "group": "Body",
14781             "type": "String",
14782             "optional": true,
14783             "field": "uniqueid",
14784             "description": ""
14785           },
14786           {
14787             "group": "Body",
14788             "type": "String",
14789             "optional": true,
14790             "field": "calleridname",
14791             "description": ""
14792           },
14793           {
14794             "group": "Body",
14795             "type": "String",
14796             "optional": true,
14797             "field": "calleridnum",
14798             "description": ""
14799           },
14800           {
14801             "group": "Body",
14802             "type": "String",
14803             "optional": true,
14804             "field": "questionId",
14805             "description": ""
14806           }
14807         ]
14808       }
14809     },
14810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14811     "version": "0.0.0",
14812     "filename": "server/api/jscriptyAnswerReport/index.js",
14813     "groupTitle": "JscriptyAnswerReport"
14814   },
14815   {
14816     "type": "delete",
14817     "url": "/api/jscripty/answers/reports/{id}",
14818     "title": "Deletes a Report",
14819     "examples": [
14820       {
14821         "title": "Example usage:",
14822         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14823         "type": "json"
14824       }
14825     ],
14826     "name": "DeleteReports",
14827     "group": "JscriptyAnswerReport",
14828     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14829     "version": "0.0.0",
14830     "filename": "server/api/jscriptyAnswerReport/index.js",
14831     "groupTitle": "JscriptyAnswerReport"
14832   },
14833   {
14834     "type": "get",
14835     "url": "/api/jscripty/answers/reports/describe",
14836     "title": "Gets table info about Reports",
14837     "examples": [
14838       {
14839         "title": "Example usage:",
14840         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14841         "type": "json"
14842       }
14843     ],
14844     "name": "DescribeReports",
14845     "group": "JscriptyAnswerReport",
14846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14847     "version": "0.0.0",
14848     "filename": "server/api/jscriptyAnswerReport/index.js",
14849     "groupTitle": "JscriptyAnswerReport"
14850   },
14851   {
14852     "type": "get",
14853     "url": "/api/jscripty/answers/reports",
14854     "title": "Gets a list of Reports",
14855     "examples": [
14856       {
14857         "title": "Example usage:",
14858         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14859         "type": "json"
14860       }
14861     ],
14862     "name": "GetReports",
14863     "group": "JscriptyAnswerReport",
14864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14865     "version": "0.0.0",
14866     "filename": "server/api/jscriptyAnswerReport/index.js",
14867     "groupTitle": "JscriptyAnswerReport"
14868   },
14869   {
14870     "type": "get",
14871     "url": "/api/jscripty/answers/reports/{id}",
14872     "title": "Gets a single Report",
14873     "examples": [
14874       {
14875         "title": "Example usage:",
14876         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14877         "type": "json"
14878       }
14879     ],
14880     "name": "ShowReports",
14881     "group": "JscriptyAnswerReport",
14882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14883     "version": "0.0.0",
14884     "filename": "server/api/jscriptyAnswerReport/index.js",
14885     "groupTitle": "JscriptyAnswerReport"
14886   },
14887   {
14888     "type": "put",
14889     "url": "/api/jscripty/answers/reports/{id}",
14890     "title": "Update an existing Report",
14891     "examples": [
14892       {
14893         "title": "Example usage:",
14894         "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",
14895         "type": "json"
14896       }
14897     ],
14898     "name": "updateReports",
14899     "group": "JscriptyAnswerReport",
14900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14901     "version": "0.0.0",
14902     "filename": "server/api/jscriptyAnswerReport/index.js",
14903     "groupTitle": "JscriptyAnswerReport"
14904   },
14905   {
14906     "type": "post",
14907     "url": "/api/jscripty/questions/reports",
14908     "title": "Creates a new Report",
14909     "examples": [
14910       {
14911         "title": "Example usage:",
14912         "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",
14913         "type": "json"
14914       }
14915     ],
14916     "name": "CreateReports",
14917     "group": "JscriptyQuestionReport",
14918     "parameter": {
14919       "fields": {
14920         "Body": [
14921           {
14922             "group": "Body",
14923             "type": "Text",
14924             "optional": true,
14925             "field": "question",
14926             "description": ""
14927           },
14928           {
14929             "group": "Body",
14930             "type": "Text",
14931             "optional": true,
14932             "field": "answer",
14933             "description": ""
14934           },
14935           {
14936             "group": "Body",
14937             "type": "String",
14938             "optional": true,
14939             "field": "membername",
14940             "description": ""
14941           },
14942           {
14943             "group": "Body",
14944             "type": "String",
14945             "optional": true,
14946             "field": "projectname",
14947             "description": ""
14948           },
14949           {
14950             "group": "Body",
14951             "type": "String",
14952             "optional": true,
14953             "field": "queue",
14954             "description": ""
14955           },
14956           {
14957             "group": "Body",
14958             "type": "String",
14959             "optional": true,
14960             "field": "uniqueid",
14961             "description": ""
14962           },
14963           {
14964             "group": "Body",
14965             "type": "String",
14966             "optional": true,
14967             "field": "calleridname",
14968             "description": ""
14969           },
14970           {
14971             "group": "Body",
14972             "type": "String",
14973             "optional": true,
14974             "field": "calleridnum",
14975             "description": ""
14976           },
14977           {
14978             "group": "Body",
14979             "type": "String",
14980             "optional": true,
14981             "field": "questionId",
14982             "description": ""
14983           }
14984         ]
14985       }
14986     },
14987     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14988     "version": "0.0.0",
14989     "filename": "server/api/jscriptyQuestionReport/index.js",
14990     "groupTitle": "JscriptyQuestionReport"
14991   },
14992   {
14993     "type": "delete",
14994     "url": "/api/jscripty/questions/reports/{id}",
14995     "title": "Deletes a Report",
14996     "examples": [
14997       {
14998         "title": "Example usage:",
14999         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
15000         "type": "json"
15001       }
15002     ],
15003     "name": "DeleteReports",
15004     "group": "JscriptyQuestionReport",
15005     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15006     "version": "0.0.0",
15007     "filename": "server/api/jscriptyQuestionReport/index.js",
15008     "groupTitle": "JscriptyQuestionReport"
15009   },
15010   {
15011     "type": "get",
15012     "url": "/api/jscripty/questions/reports/describe",
15013     "title": "Gets table info about Reports",
15014     "examples": [
15015       {
15016         "title": "Example usage:",
15017         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
15018         "type": "json"
15019       }
15020     ],
15021     "name": "DescribeReports",
15022     "group": "JscriptyQuestionReport",
15023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15024     "version": "0.0.0",
15025     "filename": "server/api/jscriptyQuestionReport/index.js",
15026     "groupTitle": "JscriptyQuestionReport"
15027   },
15028   {
15029     "type": "get",
15030     "url": "/api/jscripty/questions/reports",
15031     "title": "Gets a list of Reports",
15032     "examples": [
15033       {
15034         "title": "Example usage:",
15035         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
15036         "type": "json"
15037       }
15038     ],
15039     "name": "GetReports",
15040     "group": "JscriptyQuestionReport",
15041     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15042     "version": "0.0.0",
15043     "filename": "server/api/jscriptyQuestionReport/index.js",
15044     "groupTitle": "JscriptyQuestionReport"
15045   },
15046   {
15047     "type": "get",
15048     "url": "/api/jscripty/questions/reports/{id}",
15049     "title": "Gets a single Report",
15050     "examples": [
15051       {
15052         "title": "Example usage:",
15053         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
15054         "type": "json"
15055       }
15056     ],
15057     "name": "ShowReports",
15058     "group": "JscriptyQuestionReport",
15059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15060     "version": "0.0.0",
15061     "filename": "server/api/jscriptyQuestionReport/index.js",
15062     "groupTitle": "JscriptyQuestionReport"
15063   },
15064   {
15065     "type": "put",
15066     "url": "/api/jscripty/questions/reports/{id}",
15067     "title": "Update an existing Report",
15068     "examples": [
15069       {
15070         "title": "Example usage:",
15071         "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",
15072         "type": "json"
15073       }
15074     ],
15075     "name": "updateReports",
15076     "group": "JscriptyQuestionReport",
15077     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15078     "version": "0.0.0",
15079     "filename": "server/api/jscriptyQuestionReport/index.js",
15080     "groupTitle": "JscriptyQuestionReport"
15081   },
15082   {
15083     "type": "post",
15084     "url": "/api/jscripty/sessions/reports",
15085     "title": "Creates a new Report",
15086     "examples": [
15087       {
15088         "title": "Example usage:",
15089         "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",
15090         "type": "json"
15091       }
15092     ],
15093     "name": "CreateReports",
15094     "group": "JscriptySessionReport",
15095     "parameter": {
15096       "fields": {
15097         "Body": [
15098           {
15099             "group": "Body",
15100             "type": "String",
15101             "optional": true,
15102             "field": "starttime",
15103             "description": ""
15104           },
15105           {
15106             "group": "Body",
15107             "type": "String",
15108             "optional": true,
15109             "field": "endtime",
15110             "description": ""
15111           },
15112           {
15113             "group": "Body",
15114             "type": "String",
15115             "optional": true,
15116             "field": "membername",
15117             "description": ""
15118           },
15119           {
15120             "group": "Body",
15121             "type": "String",
15122             "optional": true,
15123             "field": "projectname",
15124             "description": ""
15125           },
15126           {
15127             "group": "Body",
15128             "type": "String",
15129             "optional": true,
15130             "field": "queue",
15131             "description": ""
15132           },
15133           {
15134             "group": "Body",
15135             "type": "String",
15136             "optional": true,
15137             "field": "uniqueid",
15138             "description": ""
15139           },
15140           {
15141             "group": "Body",
15142             "type": "String",
15143             "optional": true,
15144             "field": "calleridname",
15145             "description": ""
15146           },
15147           {
15148             "group": "Body",
15149             "type": "String",
15150             "optional": true,
15151             "field": "calleridnum",
15152             "description": ""
15153           },
15154           {
15155             "group": "Body",
15156             "type": "Boolean",
15157             "optional": true,
15158             "field": "completed",
15159             "description": ""
15160           }
15161         ]
15162       }
15163     },
15164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15165     "version": "0.0.0",
15166     "filename": "server/api/jscriptySessionReport/index.js",
15167     "groupTitle": "JscriptySessionReport"
15168   },
15169   {
15170     "type": "delete",
15171     "url": "/api/jscripty/sessions/reports/{id}",
15172     "title": "Deletes a Report",
15173     "examples": [
15174       {
15175         "title": "Example usage:",
15176         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
15177         "type": "json"
15178       }
15179     ],
15180     "name": "DeleteReports",
15181     "group": "JscriptySessionReport",
15182     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15183     "version": "0.0.0",
15184     "filename": "server/api/jscriptySessionReport/index.js",
15185     "groupTitle": "JscriptySessionReport"
15186   },
15187   {
15188     "type": "get",
15189     "url": "/api/jscripty/sessions/reports/describe",
15190     "title": "Gets table info about Reports",
15191     "examples": [
15192       {
15193         "title": "Example usage:",
15194         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
15195         "type": "json"
15196       }
15197     ],
15198     "name": "DescribeReports",
15199     "group": "JscriptySessionReport",
15200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15201     "version": "0.0.0",
15202     "filename": "server/api/jscriptySessionReport/index.js",
15203     "groupTitle": "JscriptySessionReport"
15204   },
15205   {
15206     "type": "get",
15207     "url": "/api/jscripty/sessions/reports",
15208     "title": "Gets a list of Reports",
15209     "examples": [
15210       {
15211         "title": "Example usage:",
15212         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
15213         "type": "json"
15214       }
15215     ],
15216     "name": "GetReports",
15217     "group": "JscriptySessionReport",
15218     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15219     "version": "0.0.0",
15220     "filename": "server/api/jscriptySessionReport/index.js",
15221     "groupTitle": "JscriptySessionReport"
15222   },
15223   {
15224     "type": "get",
15225     "url": "/api/jscripty/sessions/reports/{id}",
15226     "title": "Gets a single Report",
15227     "examples": [
15228       {
15229         "title": "Example usage:",
15230         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15231         "type": "json"
15232       }
15233     ],
15234     "name": "ShowReports",
15235     "group": "JscriptySessionReport",
15236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15237     "version": "0.0.0",
15238     "filename": "server/api/jscriptySessionReport/index.js",
15239     "groupTitle": "JscriptySessionReport"
15240   },
15241   {
15242     "type": "get",
15243     "url": "/api/jscripty/sessions/reports/{id}/questions",
15244     "title": "Gets Jscripty Session questions",
15245     "examples": [
15246       {
15247         "title": "Example usage:",
15248         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
15249         "type": "json"
15250       }
15251     ],
15252     "name": "getQuestions",
15253     "group": "JscriptySessionReport",
15254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15255     "version": "0.0.0",
15256     "filename": "server/api/jscriptySessionReport/index.js",
15257     "groupTitle": "JscriptySessionReport"
15258   },
15259   {
15260     "type": "put",
15261     "url": "/api/jscripty/sessions/reports/{id}",
15262     "title": "Update an existing Report",
15263     "examples": [
15264       {
15265         "title": "Example usage:",
15266         "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",
15267         "type": "json"
15268       }
15269     ],
15270     "name": "updateReports",
15271     "group": "JscriptySessionReport",
15272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15273     "version": "0.0.0",
15274     "filename": "server/api/jscriptySessionReport/index.js",
15275     "groupTitle": "JscriptySessionReport"
15276   },
15277   {
15278     "type": "post",
15279     "url": "/api/jscripty/projects/clone",
15280     "title": "Clone an existing Project",
15281     "examples": [
15282       {
15283         "title": "Example usage:",
15284         "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",
15285         "type": "json"
15286       }
15287     ],
15288     "name": "CloneProjects",
15289     "group": "Jscripty_Projects",
15290     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15291     "version": "0.0.0",
15292     "filename": "server/api/jscriptyProject/index.js",
15293     "groupTitle": "Jscripty_Projects"
15294   },
15295   {
15296     "type": "post",
15297     "url": "/api/jscripty/projects",
15298     "title": "Creates a new Project",
15299     "examples": [
15300       {
15301         "title": "Example usage:",
15302         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15303         "type": "json"
15304       }
15305     ],
15306     "name": "CreateProjects",
15307     "group": "Jscripty_Projects",
15308     "parameter": {
15309       "fields": {
15310         "Body": [
15311           {
15312             "group": "Body",
15313             "type": "String",
15314             "optional": true,
15315             "field": "name",
15316             "description": ""
15317           },
15318           {
15319             "group": "Body",
15320             "type": "String",
15321             "optional": true,
15322             "field": "description",
15323             "description": ""
15324           },
15325           {
15326             "group": "Body",
15327             "type": "Text",
15328             "optional": true,
15329             "field": "formData",
15330             "description": ""
15331           },
15332           {
15333             "group": "Body",
15334             "type": "Boolean",
15335             "optional": true,
15336             "field": "enableUncompleteSave",
15337             "description": ""
15338           },
15339           {
15340             "group": "Body",
15341             "type": "Boolean",
15342             "optional": true,
15343             "field": "sendUnpauseOnSubmit",
15344             "description": ""
15345           }
15346         ]
15347       }
15348     },
15349     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15350     "version": "0.0.0",
15351     "filename": "server/api/jscriptyProject/index.js",
15352     "groupTitle": "Jscripty_Projects"
15353   },
15354   {
15355     "type": "delete",
15356     "url": "/api/jscripty/projects/{id}",
15357     "title": "Deletes a Project",
15358     "examples": [
15359       {
15360         "title": "Example usage:",
15361         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15362         "type": "json"
15363       }
15364     ],
15365     "name": "DeleteProjects",
15366     "group": "Jscripty_Projects",
15367     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15368     "version": "0.0.0",
15369     "filename": "server/api/jscriptyProject/index.js",
15370     "groupTitle": "Jscripty_Projects"
15371   },
15372   {
15373     "type": "get",
15374     "url": "/api/jscripty/projects",
15375     "title": "Gets a list of Projects",
15376     "examples": [
15377       {
15378         "title": "Example usage:",
15379         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15380         "type": "json"
15381       }
15382     ],
15383     "name": "GetProjects",
15384     "group": "Jscripty_Projects",
15385     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15386     "version": "0.0.0",
15387     "filename": "server/api/jscriptyProject/index.js",
15388     "groupTitle": "Jscripty_Projects"
15389   },
15390   {
15391     "type": "get",
15392     "url": "/api/jscripty/projects/{id}",
15393     "title": "Gets a single Project",
15394     "examples": [
15395       {
15396         "title": "Example usage:",
15397         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15398         "type": "json"
15399       }
15400     ],
15401     "name": "ShowProjects",
15402     "group": "Jscripty_Projects",
15403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15404     "version": "0.0.0",
15405     "filename": "server/api/jscriptyProject/index.js",
15406     "groupTitle": "Jscripty_Projects"
15407   },
15408   {
15409     "type": "get",
15410     "url": "/api/jscripty/projects/{id}/answers",
15411     "title": "Gets jscripty project answers",
15412     "examples": [
15413       {
15414         "title": "Example usage:",
15415         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
15416         "type": "json"
15417       }
15418     ],
15419     "name": "getAnswers",
15420     "group": "Jscripty_Projects",
15421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15422     "version": "0.0.0",
15423     "filename": "server/api/jscriptyProject/index.js",
15424     "groupTitle": "Jscripty_Projects"
15425   },
15426   {
15427     "type": "get",
15428     "url": "/api/jscripty/projects/{id}/sessions",
15429     "title": "Gets jscripty project sessions",
15430     "examples": [
15431       {
15432         "title": "Example usage:",
15433         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
15434         "type": "json"
15435       }
15436     ],
15437     "name": "getSessions",
15438     "group": "Jscripty_Projects",
15439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15440     "version": "0.0.0",
15441     "filename": "server/api/jscriptyProject/index.js",
15442     "groupTitle": "Jscripty_Projects"
15443   },
15444   {
15445     "type": "get",
15446     "url": "/api/jscripty/projects/{id}/summary",
15447     "title": "Gets jscripty project summary",
15448     "examples": [
15449       {
15450         "title": "Example usage:",
15451         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
15452         "type": "json"
15453       }
15454     ],
15455     "name": "getSummary",
15456     "group": "Jscripty_Projects",
15457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15458     "version": "0.0.0",
15459     "filename": "server/api/jscriptyProject/index.js",
15460     "groupTitle": "Jscripty_Projects"
15461   },
15462   {
15463     "type": "put",
15464     "url": "/api/jscripty/projects/{id}",
15465     "title": "Update an existing Project",
15466     "examples": [
15467       {
15468         "title": "Example usage:",
15469         "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",
15470         "type": "json"
15471       }
15472     ],
15473     "name": "updateProjects",
15474     "group": "Jscripty_Projects",
15475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15476     "version": "0.0.0",
15477     "filename": "server/api/jscriptyProject/index.js",
15478     "groupTitle": "Jscripty_Projects"
15479   },
15480   {
15481     "type": "get",
15482     "url": "/api/license",
15483     "title": "Gets License Info",
15484     "examples": [
15485       {
15486         "title": "Example usage:",
15487         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15488         "type": "json"
15489       }
15490     ],
15491     "name": "index",
15492     "group": "License",
15493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15494     "version": "0.0.0",
15495     "filename": "server/api/license/index.js",
15496     "groupTitle": "License"
15497   },
15498   {
15499     "type": "put",
15500     "url": "/api/license/{id}",
15501     "title": "Update License Info",
15502     "examples": [
15503       {
15504         "title": "Example usage:",
15505         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15506         "type": "json"
15507       }
15508     ],
15509     "name": "update",
15510     "group": "License",
15511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15512     "version": "0.0.0",
15513     "filename": "server/api/license/index.js",
15514     "groupTitle": "License"
15515   },
15516   {
15517     "type": "get",
15518     "url": "/api/mail_interaction_has_tags/describe",
15519     "title": "Gets table info about Mail Iteraction Tags",
15520     "examples": [
15521       {
15522         "title": "Example usage:",
15523         "content": "curl https://{domain}/api/mail_interaction_has_tags/describe -v -u {name}:{password}",
15524         "type": "json"
15525       }
15526     ],
15527     "name": "DescribeMailInteractionTags",
15528     "group": "MailInteractionTags",
15529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15530     "version": "0.0.0",
15531     "filename": "server/api/mailInteractionHasTag/index.js",
15532     "groupTitle": "MailInteractionTags"
15533   },
15534   {
15535     "type": "post",
15536     "url": "/api/mail/accounts/{id}/users",
15537     "title": "Add agents to a mail account",
15538     "examples": [
15539       {
15540         "title": "Example usage:",
15541         "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",
15542         "type": "json"
15543       }
15544     ],
15545     "name": "AddAgents",
15546     "group": "Mail_Accounts",
15547     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15548     "version": "0.0.0",
15549     "filename": "server/api/mailAccount/index.js",
15550     "groupTitle": "Mail_Accounts"
15551   },
15552   {
15553     "type": "post",
15554     "url": "/api/mail/accounts/{id}/in_servers",
15555     "title": "Creates a new IMAP server",
15556     "examples": [
15557       {
15558         "title": "Example usage:",
15559         "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",
15560         "type": "json"
15561       }
15562     ],
15563     "name": "AddImap",
15564     "group": "Mail_Accounts",
15565     "parameter": {
15566       "fields": {
15567         "Body": [
15568           {
15569             "group": "Body",
15570             "type": "String",
15571             "optional": true,
15572             "field": "description",
15573             "description": ""
15574           },
15575           {
15576             "group": "Body",
15577             "type": "String",
15578             "optional": true,
15579             "field": "host",
15580             "description": ""
15581           },
15582           {
15583             "group": "Body",
15584             "type": "Boolean",
15585             "optional": true,
15586             "field": "authentication",
15587             "description": ""
15588           },
15589           {
15590             "group": "Body",
15591             "type": "String",
15592             "optional": true,
15593             "field": "user",
15594             "description": ""
15595           },
15596           {
15597             "group": "Body",
15598             "type": "String",
15599             "optional": true,
15600             "field": "password",
15601             "description": ""
15602           },
15603           {
15604             "group": "Body",
15605             "type": "Integer",
15606             "optional": true,
15607             "field": "port",
15608             "description": ""
15609           },
15610           {
15611             "group": "Body",
15612             "type": "Boolean",
15613             "optional": true,
15614             "field": "tls",
15615             "description": ""
15616           },
15617           {
15618             "group": "Body",
15619             "type": "String",
15620             "optional": true,
15621             "field": "mailbox",
15622             "description": ""
15623           },
15624           {
15625             "group": "Body",
15626             "type": "Integer",
15627             "optional": true,
15628             "field": "connTimeout",
15629             "description": ""
15630           },
15631           {
15632             "group": "Body",
15633             "type": "Integer",
15634             "optional": true,
15635             "field": "authTimeout",
15636             "description": ""
15637           },
15638           {
15639             "group": "Body",
15640             "type": "String",
15641             "optional": true,
15642             "field": "service",
15643             "description": ""
15644           }
15645         ]
15646       }
15647     },
15648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15649     "version": "0.0.0",
15650     "filename": "server/api/mailAccount/index.js",
15651     "groupTitle": "Mail_Accounts"
15652   },
15653   {
15654     "type": "post",
15655     "url": "/api/mail/accounts/{id}/out_servers",
15656     "title": "Creates a new SMTP server",
15657     "examples": [
15658       {
15659         "title": "Example usage:",
15660         "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",
15661         "type": "json"
15662       }
15663     ],
15664     "name": "AddSmtp",
15665     "group": "Mail_Accounts",
15666     "parameter": {
15667       "fields": {
15668         "Body": [
15669           {
15670             "group": "Body",
15671             "type": "String",
15672             "optional": true,
15673             "field": "description",
15674             "description": ""
15675           },
15676           {
15677             "group": "Body",
15678             "type": "String",
15679             "optional": true,
15680             "field": "host",
15681             "description": ""
15682           },
15683           {
15684             "group": "Body",
15685             "type": "String",
15686             "optional": true,
15687             "field": "user",
15688             "description": ""
15689           },
15690           {
15691             "group": "Body",
15692             "type": "String",
15693             "optional": true,
15694             "field": "pass",
15695             "description": ""
15696           },
15697           {
15698             "group": "Body",
15699             "type": "Integer",
15700             "optional": true,
15701             "field": "port",
15702             "description": ""
15703           },
15704           {
15705             "group": "Body",
15706             "type": "Boolean",
15707             "optional": true,
15708             "field": "secure",
15709             "description": ""
15710           },
15711           {
15712             "group": "Body",
15713             "type": "String",
15714             "optional": true,
15715             "field": "service",
15716             "description": ""
15717           },
15718           {
15719             "group": "Body",
15720             "type": "Boolean",
15721             "optional": true,
15722             "field": "authentication",
15723             "description": ""
15724           }
15725         ]
15726       }
15727     },
15728     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15729     "version": "0.0.0",
15730     "filename": "server/api/mailAccount/index.js",
15731     "groupTitle": "Mail_Accounts"
15732   },
15733   {
15734     "type": "delete",
15735     "url": "/api/mail/accounts/{id}",
15736     "title": "Deletes a mail account",
15737     "examples": [
15738       {
15739         "title": "Example usage:",
15740         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15741         "type": "json"
15742       }
15743     ],
15744     "name": "DeleteMailAccounts",
15745     "group": "Mail_Accounts",
15746     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15747     "version": "0.0.0",
15748     "filename": "server/api/mailAccount/index.js",
15749     "groupTitle": "Mail_Accounts"
15750   },
15751   {
15752     "type": "get",
15753     "url": "/api/mail/accounts/describe",
15754     "title": "Gets table info about Accounts",
15755     "examples": [
15756       {
15757         "title": "Example usage:",
15758         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15759         "type": "json"
15760       }
15761     ],
15762     "name": "DescribeAccounts",
15763     "group": "Mail_Accounts",
15764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15765     "version": "0.0.0",
15766     "filename": "server/api/mailAccount/index.js",
15767     "groupTitle": "Mail_Accounts"
15768   },
15769   {
15770     "type": "get",
15771     "url": "/api/mail/accounts",
15772     "title": "Gets a list of Accounts",
15773     "examples": [
15774       {
15775         "title": "Example usage:",
15776         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15777         "type": "json"
15778       }
15779     ],
15780     "name": "GetAccounts",
15781     "group": "Mail_Accounts",
15782     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15783     "version": "0.0.0",
15784     "filename": "server/api/mailAccount/index.js",
15785     "groupTitle": "Mail_Accounts"
15786   },
15787   {
15788     "type": "get",
15789     "url": "/api/mail/accounts/{id}/users",
15790     "title": "Gets agents from mail account",
15791     "examples": [
15792       {
15793         "title": "Example usage:",
15794         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15795         "type": "json"
15796       }
15797     ],
15798     "name": "GetAgents",
15799     "group": "Mail_Accounts",
15800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15801     "version": "0.0.0",
15802     "filename": "server/api/mailAccount/index.js",
15803     "groupTitle": "Mail_Accounts"
15804   },
15805   {
15806     "type": "get",
15807     "url": "/api/mail/accounts/{id}/in_servers",
15808     "title": "Gets account IMAP server",
15809     "examples": [
15810       {
15811         "title": "Example usage:",
15812         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15813         "type": "json"
15814       }
15815     ],
15816     "name": "GetImap",
15817     "group": "Mail_Accounts",
15818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15819     "version": "0.0.0",
15820     "filename": "server/api/mailAccount/index.js",
15821     "groupTitle": "Mail_Accounts"
15822   },
15823   {
15824     "type": "get",
15825     "url": "/api/mail/accounts/{id}/out_servers",
15826     "title": "Gets account SMTP server",
15827     "examples": [
15828       {
15829         "title": "Example usage:",
15830         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15831         "type": "json"
15832       }
15833     ],
15834     "name": "GetSmtp",
15835     "group": "Mail_Accounts",
15836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15837     "version": "0.0.0",
15838     "filename": "server/api/mailAccount/index.js",
15839     "groupTitle": "Mail_Accounts"
15840   },
15841   {
15842     "type": "delete",
15843     "url": "/api/mail/accounts/{id}/users",
15844     "title": "Removes agents from a mail account",
15845     "examples": [
15846       {
15847         "title": "Example usage:",
15848         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15849         "type": "json"
15850       }
15851     ],
15852     "name": "RemoveAgents",
15853     "group": "Mail_Accounts",
15854     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15855     "version": "0.0.0",
15856     "filename": "server/api/mailAccount/index.js",
15857     "groupTitle": "Mail_Accounts"
15858   },
15859   {
15860     "type": "delete",
15861     "url": "/api/mail/accounts/{id}/canned_answers",
15862     "title": "Removes canned answers from account",
15863     "examples": [
15864       {
15865         "title": "Example usage:",
15866         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15867         "type": "json"
15868       }
15869     ],
15870     "name": "RemoveAnswers",
15871     "group": "Mail_Accounts",
15872     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15873     "version": "0.0.0",
15874     "filename": "server/api/mailAccount/index.js",
15875     "groupTitle": "Mail_Accounts"
15876   },
15877   {
15878     "type": "delete",
15879     "url": "/api/mail/accounts/{id}/dispositions",
15880     "title": "Removes dispositions from account",
15881     "examples": [
15882       {
15883         "title": "Example usage:",
15884         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15885         "type": "json"
15886       }
15887     ],
15888     "name": "RemoveDispositions",
15889     "group": "Mail_Accounts",
15890     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15891     "version": "0.0.0",
15892     "filename": "server/api/mailAccount/index.js",
15893     "groupTitle": "Mail_Accounts"
15894   },
15895   {
15896     "type": "delete",
15897     "url": "/api/mail/accounts/{id}/in_servers",
15898     "title": "Removes IMAP server from an account",
15899     "examples": [
15900       {
15901         "title": "Example usage:",
15902         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15903         "type": "json"
15904       }
15905     ],
15906     "name": "RemoveImmap",
15907     "group": "Mail_Accounts",
15908     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15909     "version": "0.0.0",
15910     "filename": "server/api/mailAccount/index.js",
15911     "groupTitle": "Mail_Accounts"
15912   },
15913   {
15914     "type": "delete",
15915     "url": "/api/mail/accounts/{id}/out_servers",
15916     "title": "Removes SMTP server from an account",
15917     "examples": [
15918       {
15919         "title": "Example usage:",
15920         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15921         "type": "json"
15922       }
15923     ],
15924     "name": "RemoveSmtp",
15925     "group": "Mail_Accounts",
15926     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15927     "version": "0.0.0",
15928     "filename": "server/api/mailAccount/index.js",
15929     "groupTitle": "Mail_Accounts"
15930   },
15931   {
15932     "type": "get",
15933     "url": "/api/mail/accounts/{id}",
15934     "title": "Gets a single Account",
15935     "examples": [
15936       {
15937         "title": "Example usage:",
15938         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15939         "type": "json"
15940       }
15941     ],
15942     "name": "ShowAccounts",
15943     "group": "Mail_Accounts",
15944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15945     "version": "0.0.0",
15946     "filename": "server/api/mailAccount/index.js",
15947     "groupTitle": "Mail_Accounts"
15948   },
15949   {
15950     "type": "post",
15951     "url": "/api/mail/accounts/{id}/canned_answers",
15952     "title": "Creates new canned answer",
15953     "examples": [
15954       {
15955         "title": "Example usage:",
15956         "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",
15957         "type": "json"
15958       }
15959     ],
15960     "name": "addAnswer",
15961     "group": "Mail_Accounts",
15962     "parameter": {
15963       "fields": {
15964         "Body": [
15965           {
15966             "group": "Body",
15967             "type": "String",
15968             "optional": false,
15969             "field": "key",
15970             "description": ""
15971           },
15972           {
15973             "group": "Body",
15974             "type": "Text",
15975             "optional": false,
15976             "field": "value",
15977             "description": ""
15978           },
15979           {
15980             "group": "Body",
15981             "type": "String",
15982             "optional": true,
15983             "field": "description",
15984             "description": ""
15985           },
15986           {
15987             "group": "Body",
15988             "type": "Virtual",
15989             "optional": true,
15990             "field": "name",
15991             "description": ""
15992           }
15993         ]
15994       }
15995     },
15996     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15997     "version": "0.0.0",
15998     "filename": "server/api/mailAccount/index.js",
15999     "groupTitle": "Mail_Accounts"
16000   },
16001   {
16002     "type": "post",
16003     "url": "/api/mail/accounts/{id}/applications",
16004     "title": "Creates new applications",
16005     "examples": [
16006       {
16007         "title": "Example usage:",
16008         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16009         "type": "json"
16010       }
16011     ],
16012     "name": "addApplications",
16013     "group": "Mail_Accounts",
16014     "parameter": {
16015       "fields": {
16016         "Body": [
16017           {
16018             "group": "Body",
16019             "type": "Integer",
16020             "optional": false,
16021             "field": "priority",
16022             "description": ""
16023           },
16024           {
16025             "group": "Body",
16026             "type": "String",
16027             "optional": false,
16028             "field": "app",
16029             "description": ""
16030           },
16031           {
16032             "group": "Body",
16033             "type": "Text",
16034             "optional": true,
16035             "field": "appdata",
16036             "description": ""
16037           },
16038           {
16039             "group": "Body",
16040             "type": "String",
16041             "optional": true,
16042             "field": "description",
16043             "description": ""
16044           },
16045           {
16046             "group": "Body",
16047             "type": "String",
16048             "optional": true,
16049             "field": "interval",
16050             "description": ""
16051           }
16052         ]
16053       }
16054     },
16055     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16056     "version": "0.0.0",
16057     "filename": "server/api/mailAccount/index.js",
16058     "groupTitle": "Mail_Accounts"
16059   },
16060   {
16061     "type": "post",
16062     "url": "/api/mail/accounts/{id}/dispositions",
16063     "title": "Creates new disposition",
16064     "examples": [
16065       {
16066         "title": "Example usage:",
16067         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16068         "type": "json"
16069       }
16070     ],
16071     "name": "addDisposition",
16072     "group": "Mail_Accounts",
16073     "parameter": {
16074       "fields": {
16075         "Body": [
16076           {
16077             "group": "Body",
16078             "type": "String",
16079             "optional": false,
16080             "field": "name",
16081             "description": ""
16082           },
16083           {
16084             "group": "Body",
16085             "type": "String",
16086             "allowedValues": [
16087               "\"first\"",
16088               "\"second\"",
16089               "\"third\""
16090             ],
16091             "optional": false,
16092             "field": "level",
16093             "description": ""
16094           },
16095           {
16096             "group": "Body",
16097             "type": "String",
16098             "optional": true,
16099             "field": "description",
16100             "description": ""
16101           }
16102         ]
16103       }
16104     },
16105     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16106     "version": "0.0.0",
16107     "filename": "server/api/mailAccount/index.js",
16108     "groupTitle": "Mail_Accounts"
16109   },
16110   {
16111     "type": "post",
16112     "url": "/api/mail/accounts/{id}/interactions",
16113     "title": "Creates new interactions",
16114     "examples": [
16115       {
16116         "title": "Example usage:",
16117         "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",
16118         "type": "json"
16119       }
16120     ],
16121     "name": "addInteraction",
16122     "group": "Mail_Accounts",
16123     "parameter": {
16124       "fields": {
16125         "Body": [
16126           {
16127             "group": "Body",
16128             "type": "Boolean",
16129             "optional": true,
16130             "field": "closed",
16131             "description": ""
16132           },
16133           {
16134             "group": "Body",
16135             "type": "String",
16136             "optional": true,
16137             "field": "closedAt",
16138             "description": ""
16139           },
16140           {
16141             "group": "Body",
16142             "type": "String",
16143             "optional": true,
16144             "field": "disposition",
16145             "description": ""
16146           },
16147           {
16148             "group": "Body",
16149             "type": "String",
16150             "optional": true,
16151             "field": "secondDisposition",
16152             "description": ""
16153           },
16154           {
16155             "group": "Body",
16156             "type": "String",
16157             "optional": true,
16158             "field": "thirdDisposition",
16159             "description": ""
16160           },
16161           {
16162             "group": "Body",
16163             "type": "String",
16164             "optional": true,
16165             "field": "note",
16166             "description": ""
16167           },
16168           {
16169             "group": "Body",
16170             "type": "String",
16171             "optional": true,
16172             "field": "inReplyTo",
16173             "description": ""
16174           },
16175           {
16176             "group": "Body",
16177             "type": "String",
16178             "optional": true,
16179             "field": "to",
16180             "description": ""
16181           },
16182           {
16183             "group": "Body",
16184             "type": "Text",
16185             "optional": true,
16186             "field": "cc",
16187             "description": ""
16188           },
16189           {
16190             "group": "Body",
16191             "type": "Text",
16192             "optional": true,
16193             "field": "subject",
16194             "description": ""
16195           },
16196           {
16197             "group": "Body",
16198             "type": "Boolean",
16199             "optional": true,
16200             "field": "attach",
16201             "description": ""
16202           },
16203           {
16204             "group": "Body",
16205             "type": "String",
16206             "optional": true,
16207             "field": "read1stAt",
16208             "description": ""
16209           },
16210           {
16211             "group": "Body",
16212             "type": "String",
16213             "optional": true,
16214             "field": "substatus",
16215             "description": ""
16216           },
16217           {
16218             "group": "Body",
16219             "type": "String",
16220             "optional": true,
16221             "field": "substatusAt",
16222             "description": ""
16223           },
16224           {
16225             "group": "Body",
16226             "type": "String",
16227             "allowedValues": [
16228               "\"in\"",
16229               "\"out\""
16230             ],
16231             "optional": false,
16232             "field": "firstMsgDirection",
16233             "description": ""
16234           },
16235           {
16236             "group": "Body",
16237             "type": "String",
16238             "optional": true,
16239             "field": "lastMsgAt",
16240             "description": ""
16241           },
16242           {
16243             "group": "Body",
16244             "type": "String",
16245             "allowedValues": [
16246               "\"in\"",
16247               "\"out\""
16248             ],
16249             "optional": false,
16250             "field": "lastMsgDirection",
16251             "description": ""
16252           },
16253           {
16254             "group": "Body",
16255             "type": "Boolean",
16256             "optional": true,
16257             "field": "autoreplyExecuted",
16258             "description": ""
16259           }
16260         ]
16261       }
16262     },
16263     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16264     "version": "0.0.0",
16265     "filename": "server/api/mailAccount/index.js",
16266     "groupTitle": "Mail_Accounts"
16267   },
16268   {
16269     "type": "post",
16270     "url": "/api/mail/accounts",
16271     "title": "Create a mail account",
16272     "examples": [
16273       {
16274         "title": "Example usage:",
16275         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16276         "type": "json"
16277       }
16278     ],
16279     "name": "create",
16280     "group": "Mail_Accounts",
16281     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16282     "version": "0.0.0",
16283     "filename": "server/api/mailAccount/index.js",
16284     "groupTitle": "Mail_Accounts"
16285   },
16286   {
16287     "type": "get",
16288     "url": "/api/mail/accounts/{id}/canned_answers",
16289     "title": "Gets account canned answers",
16290     "examples": [
16291       {
16292         "title": "Example usage:",
16293         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16294         "type": "json"
16295       }
16296     ],
16297     "name": "getAnswers",
16298     "group": "Mail_Accounts",
16299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16300     "version": "0.0.0",
16301     "filename": "server/api/mailAccount/index.js",
16302     "groupTitle": "Mail_Accounts"
16303   },
16304   {
16305     "type": "get",
16306     "url": "/api/mail/accounts/{id}/applications",
16307     "title": "Gets account applications",
16308     "examples": [
16309       {
16310         "title": "Example usage:",
16311         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16312         "type": "json"
16313       }
16314     ],
16315     "name": "getApplications",
16316     "group": "Mail_Accounts",
16317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16318     "version": "0.0.0",
16319     "filename": "server/api/mailAccount/index.js",
16320     "groupTitle": "Mail_Accounts"
16321   },
16322   {
16323     "type": "get",
16324     "url": "/api/mail/accounts/{id}/dispositions",
16325     "title": "Gets account dispositions",
16326     "examples": [
16327       {
16328         "title": "Example usage:",
16329         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16330         "type": "json"
16331       }
16332     ],
16333     "name": "getDispositions",
16334     "group": "Mail_Accounts",
16335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16336     "version": "0.0.0",
16337     "filename": "server/api/mailAccount/index.js",
16338     "groupTitle": "Mail_Accounts"
16339   },
16340   {
16341     "type": "get",
16342     "url": "/api/mail/accounts/{id}/interactions",
16343     "title": "Gets account interactions",
16344     "examples": [
16345       {
16346         "title": "Example usage:",
16347         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16348         "type": "json"
16349       }
16350     ],
16351     "name": "getInteraction",
16352     "group": "Mail_Accounts",
16353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16354     "version": "0.0.0",
16355     "filename": "server/api/mailAccount/index.js",
16356     "groupTitle": "Mail_Accounts"
16357   },
16358   {
16359     "type": "get",
16360     "url": "/api/mail/accounts/{id}/messages",
16361     "title": "Gets account messages",
16362     "examples": [
16363       {
16364         "title": "Example usage:",
16365         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16366         "type": "json"
16367       }
16368     ],
16369     "name": "getMessages",
16370     "group": "Mail_Accounts",
16371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16372     "version": "0.0.0",
16373     "filename": "server/api/mailAccount/index.js",
16374     "groupTitle": "Mail_Accounts"
16375   },
16376   {
16377     "type": "post",
16378     "url": "/api/mail/accounts/{id}/send",
16379     "title": "Send new mail",
16380     "examples": [
16381       {
16382         "title": "Example usage:",
16383         "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",
16384         "type": "json"
16385       }
16386     ],
16387     "name": "sendMail",
16388     "group": "Mail_Accounts",
16389     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16390     "version": "0.0.0",
16391     "filename": "server/api/mailAccount/index.js",
16392     "groupTitle": "Mail_Accounts"
16393   },
16394   {
16395     "type": "put",
16396     "url": "/api/mail/accounts/{id}",
16397     "title": "Update an existing Account",
16398     "examples": [
16399       {
16400         "title": "Example usage:",
16401         "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",
16402         "type": "json"
16403       }
16404     ],
16405     "name": "updateAccounts",
16406     "group": "Mail_Accounts",
16407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16408     "version": "0.0.0",
16409     "filename": "server/api/mailAccount/index.js",
16410     "groupTitle": "Mail_Accounts"
16411   },
16412   {
16413     "type": "get",
16414     "url": "/api/mail/accounts/{id}/verify",
16415     "title": "Verify mail account",
16416     "examples": [
16417       {
16418         "title": "Example usage:",
16419         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16420         "type": "json"
16421       }
16422     ],
16423     "name": "verifySmtp",
16424     "group": "Mail_Accounts",
16425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16426     "version": "0.0.0",
16427     "filename": "server/api/mailAccount/index.js",
16428     "groupTitle": "Mail_Accounts"
16429   },
16430   {
16431     "type": "delete",
16432     "url": "/api/mail/applications/{id}",
16433     "title": "Deletes a Application",
16434     "examples": [
16435       {
16436         "title": "Example usage:",
16437         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16438         "type": "json"
16439       }
16440     ],
16441     "name": "DeleteApplications",
16442     "group": "Mail_Applications",
16443     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16444     "version": "0.0.0",
16445     "filename": "server/api/mailApplication/index.js",
16446     "groupTitle": "Mail_Applications"
16447   },
16448   {
16449     "type": "get",
16450     "url": "/api/mail/applications/{id}",
16451     "title": "Gets a single Application",
16452     "examples": [
16453       {
16454         "title": "Example usage:",
16455         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16456         "type": "json"
16457       }
16458     ],
16459     "name": "ShowApplications",
16460     "group": "Mail_Applications",
16461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16462     "version": "0.0.0",
16463     "filename": "server/api/mailApplication/index.js",
16464     "groupTitle": "Mail_Applications"
16465   },
16466   {
16467     "type": "put",
16468     "url": "/api/mail/applications/{id}",
16469     "title": "Update an existing Application",
16470     "examples": [
16471       {
16472         "title": "Example usage:",
16473         "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",
16474         "type": "json"
16475       }
16476     ],
16477     "name": "updateApplications",
16478     "group": "Mail_Applications",
16479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16480     "version": "0.0.0",
16481     "filename": "server/api/mailApplication/index.js",
16482     "groupTitle": "Mail_Applications"
16483   },
16484   {
16485     "type": "post",
16486     "url": "/api/mail/interactions/{id}/tags",
16487     "title": "Add tags to the interaction",
16488     "examples": [
16489       {
16490         "title": "Example usage:",
16491         "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",
16492         "type": "json"
16493       }
16494     ],
16495     "name": "AddTags",
16496     "group": "Mail_Interactions",
16497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16498     "version": "0.0.0",
16499     "filename": "server/api/mailInteraction/index.js",
16500     "groupTitle": "Mail_Interactions"
16501   },
16502   {
16503     "type": "post",
16504     "url": "/api/mail/interactions",
16505     "title": "Creates a new Interaction",
16506     "examples": [
16507       {
16508         "title": "Example usage:",
16509         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16510         "type": "json"
16511       }
16512     ],
16513     "name": "CreateInteractions",
16514     "group": "Mail_Interactions",
16515     "parameter": {
16516       "fields": {
16517         "Body": [
16518           {
16519             "group": "Body",
16520             "type": "Boolean",
16521             "optional": true,
16522             "field": "closed",
16523             "description": ""
16524           },
16525           {
16526             "group": "Body",
16527             "type": "String",
16528             "optional": true,
16529             "field": "closedAt",
16530             "description": ""
16531           },
16532           {
16533             "group": "Body",
16534             "type": "String",
16535             "optional": true,
16536             "field": "disposition",
16537             "description": ""
16538           },
16539           {
16540             "group": "Body",
16541             "type": "String",
16542             "optional": true,
16543             "field": "secondDisposition",
16544             "description": ""
16545           },
16546           {
16547             "group": "Body",
16548             "type": "String",
16549             "optional": true,
16550             "field": "thirdDisposition",
16551             "description": ""
16552           },
16553           {
16554             "group": "Body",
16555             "type": "String",
16556             "optional": true,
16557             "field": "note",
16558             "description": ""
16559           },
16560           {
16561             "group": "Body",
16562             "type": "String",
16563             "optional": true,
16564             "field": "inReplyTo",
16565             "description": ""
16566           },
16567           {
16568             "group": "Body",
16569             "type": "String",
16570             "optional": true,
16571             "field": "to",
16572             "description": ""
16573           },
16574           {
16575             "group": "Body",
16576             "type": "Text",
16577             "optional": true,
16578             "field": "cc",
16579             "description": ""
16580           },
16581           {
16582             "group": "Body",
16583             "type": "Text",
16584             "optional": true,
16585             "field": "subject",
16586             "description": ""
16587           },
16588           {
16589             "group": "Body",
16590             "type": "Boolean",
16591             "optional": true,
16592             "field": "attach",
16593             "description": ""
16594           },
16595           {
16596             "group": "Body",
16597             "type": "String",
16598             "optional": true,
16599             "field": "read1stAt",
16600             "description": ""
16601           },
16602           {
16603             "group": "Body",
16604             "type": "String",
16605             "optional": true,
16606             "field": "substatus",
16607             "description": ""
16608           },
16609           {
16610             "group": "Body",
16611             "type": "String",
16612             "optional": true,
16613             "field": "substatusAt",
16614             "description": ""
16615           },
16616           {
16617             "group": "Body",
16618             "type": "String",
16619             "allowedValues": [
16620               "\"in\"",
16621               "\"out\""
16622             ],
16623             "optional": false,
16624             "field": "firstMsgDirection",
16625             "description": ""
16626           },
16627           {
16628             "group": "Body",
16629             "type": "String",
16630             "optional": true,
16631             "field": "lastMsgAt",
16632             "description": ""
16633           },
16634           {
16635             "group": "Body",
16636             "type": "String",
16637             "allowedValues": [
16638               "\"in\"",
16639               "\"out\""
16640             ],
16641             "optional": false,
16642             "field": "lastMsgDirection",
16643             "description": ""
16644           },
16645           {
16646             "group": "Body",
16647             "type": "Boolean",
16648             "optional": true,
16649             "field": "autoreplyExecuted",
16650             "description": ""
16651           }
16652         ]
16653       }
16654     },
16655     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16656     "version": "0.0.0",
16657     "filename": "server/api/mailInteraction/index.js",
16658     "groupTitle": "Mail_Interactions"
16659   },
16660   {
16661     "type": "delete",
16662     "url": "/api/mail/interactions/{id}",
16663     "title": "Deletes a Interaction",
16664     "examples": [
16665       {
16666         "title": "Example usage:",
16667         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16668         "type": "json"
16669       }
16670     ],
16671     "name": "DeleteInteractions",
16672     "group": "Mail_Interactions",
16673     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16674     "version": "0.0.0",
16675     "filename": "server/api/mailInteraction/index.js",
16676     "groupTitle": "Mail_Interactions"
16677   },
16678   {
16679     "type": "get",
16680     "url": "/api/mail/interactions/describe",
16681     "title": "Gets table info about Interactions",
16682     "examples": [
16683       {
16684         "title": "Example usage:",
16685         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16686         "type": "json"
16687       }
16688     ],
16689     "name": "DescribeInteractions",
16690     "group": "Mail_Interactions",
16691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16692     "version": "0.0.0",
16693     "filename": "server/api/mailInteraction/index.js",
16694     "groupTitle": "Mail_Interactions"
16695   },
16696   {
16697     "type": "get",
16698     "url": "/api/mail/interactions",
16699     "title": "Gets a list of Interactions",
16700     "examples": [
16701       {
16702         "title": "Example usage:",
16703         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16704         "type": "json"
16705       }
16706     ],
16707     "name": "GetInteractions",
16708     "group": "Mail_Interactions",
16709     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16710     "version": "0.0.0",
16711     "filename": "server/api/mailInteraction/index.js",
16712     "groupTitle": "Mail_Interactions"
16713   },
16714   {
16715     "type": "delete",
16716     "url": "/api/mail/interactions/{id}/tags",
16717     "title": "Removes tags from interaction",
16718     "examples": [
16719       {
16720         "title": "Example usage:",
16721         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16722         "type": "json"
16723       }
16724     ],
16725     "name": "RemoveTags",
16726     "group": "Mail_Interactions",
16727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16728     "version": "0.0.0",
16729     "filename": "server/api/mailInteraction/index.js",
16730     "groupTitle": "Mail_Interactions"
16731   },
16732   {
16733     "type": "get",
16734     "url": "/api/mail/interactions/{id}",
16735     "title": "Gets a single Interaction",
16736     "examples": [
16737       {
16738         "title": "Example usage:",
16739         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16740         "type": "json"
16741       }
16742     ],
16743     "name": "ShowInteractions",
16744     "group": "Mail_Interactions",
16745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16746     "version": "0.0.0",
16747     "filename": "server/api/mailInteraction/index.js",
16748     "groupTitle": "Mail_Interactions"
16749   },
16750   {
16751     "type": "post",
16752     "url": "/api/mail/interactions/{id}/messages",
16753     "title": "Creates new message",
16754     "examples": [
16755       {
16756         "title": "Example usage:",
16757         "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",
16758         "type": "json"
16759       }
16760     ],
16761     "name": "addMessage",
16762     "group": "Mail_Interactions",
16763     "parameter": {
16764       "fields": {
16765         "Body": [
16766           {
16767             "group": "Body",
16768             "type": "Text",
16769             "optional": false,
16770             "field": "body",
16771             "description": ""
16772           },
16773           {
16774             "group": "Body",
16775             "type": "Text",
16776             "optional": true,
16777             "field": "plainBody",
16778             "description": ""
16779           },
16780           {
16781             "group": "Body",
16782             "type": "Boolean",
16783             "optional": true,
16784             "field": "read",
16785             "description": ""
16786           },
16787           {
16788             "group": "Body",
16789             "type": "String",
16790             "allowedValues": [
16791               "\"in\"",
16792               "\"out\""
16793             ],
16794             "optional": false,
16795             "field": "direction",
16796             "description": ""
16797           },
16798           {
16799             "group": "Body",
16800             "type": "String",
16801             "optional": true,
16802             "field": "messageId",
16803             "description": ""
16804           },
16805           {
16806             "group": "Body",
16807             "type": "String",
16808             "optional": true,
16809             "field": "from",
16810             "description": ""
16811           },
16812           {
16813             "group": "Body",
16814             "type": "Text",
16815             "optional": true,
16816             "field": "to",
16817             "description": ""
16818           },
16819           {
16820             "group": "Body",
16821             "type": "Text",
16822             "optional": true,
16823             "field": "cc",
16824             "description": ""
16825           },
16826           {
16827             "group": "Body",
16828             "type": "Text",
16829             "optional": true,
16830             "field": "bcc",
16831             "description": ""
16832           },
16833           {
16834             "group": "Body",
16835             "type": "Text",
16836             "optional": true,
16837             "field": "subject",
16838             "description": ""
16839           },
16840           {
16841             "group": "Body",
16842             "type": "String",
16843             "optional": true,
16844             "field": "sentAt",
16845             "description": ""
16846           },
16847           {
16848             "group": "Body",
16849             "type": "Integer",
16850             "optional": true,
16851             "field": "attach",
16852             "description": ""
16853           },
16854           {
16855             "group": "Body",
16856             "type": "Boolean",
16857             "optional": true,
16858             "field": "secret",
16859             "description": ""
16860           },
16861           {
16862             "group": "Body",
16863             "type": "String",
16864             "optional": true,
16865             "field": "readAt",
16866             "description": ""
16867           },
16868           {
16869             "group": "Body",
16870             "type": "Text",
16871             "optional": true,
16872             "field": "originTo",
16873             "description": ""
16874           },
16875           {
16876             "group": "Body",
16877             "type": "Text",
16878             "optional": true,
16879             "field": "originCc",
16880             "description": ""
16881           },
16882           {
16883             "group": "Body",
16884             "type": "String",
16885             "allowedValues": [
16886               "\"Email\"",
16887               "\"Chat\""
16888             ],
16889             "optional": false,
16890             "field": "originChannel",
16891             "description": ""
16892           }
16893         ]
16894       }
16895     },
16896     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16897     "version": "0.0.0",
16898     "filename": "server/api/mailInteraction/index.js",
16899     "groupTitle": "Mail_Interactions"
16900   },
16901   {
16902     "type": "get",
16903     "url": "/api/mail/interactions/{id}/download",
16904     "title": "Gets interaction",
16905     "examples": [
16906       {
16907         "title": "Example usage:",
16908         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16909         "type": "json"
16910       }
16911     ],
16912     "name": "download",
16913     "group": "Mail_Interactions",
16914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16915     "version": "0.0.0",
16916     "filename": "server/api/mailInteraction/index.js",
16917     "groupTitle": "Mail_Interactions"
16918   },
16919   {
16920     "type": "get",
16921     "url": "/api/mail/interactions/{id}/messages",
16922     "title": "Gets interaction messages",
16923     "examples": [
16924       {
16925         "title": "Example usage:",
16926         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16927         "type": "json"
16928       }
16929     ],
16930     "name": "getMessages",
16931     "group": "Mail_Interactions",
16932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16933     "version": "0.0.0",
16934     "filename": "server/api/mailInteraction/index.js",
16935     "groupTitle": "Mail_Interactions"
16936   },
16937   {
16938     "type": "put",
16939     "url": "/api/mail/interactions/{id}",
16940     "title": "Update an existing Interaction",
16941     "examples": [
16942       {
16943         "title": "Example usage:",
16944         "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",
16945         "type": "json"
16946       }
16947     ],
16948     "name": "updateInteractions",
16949     "group": "Mail_Interactions",
16950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16951     "version": "0.0.0",
16952     "filename": "server/api/mailInteraction/index.js",
16953     "groupTitle": "Mail_Interactions"
16954   },
16955   {
16956     "type": "delete",
16957     "url": "/api/mail/messages/{id}",
16958     "title": "Deletes a Message",
16959     "examples": [
16960       {
16961         "title": "Example usage:",
16962         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16963         "type": "json"
16964       }
16965     ],
16966     "name": "DeleteMessages",
16967     "group": "Mail_Messages",
16968     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16969     "version": "0.0.0",
16970     "filename": "server/api/mailMessage/index.js",
16971     "groupTitle": "Mail_Messages"
16972   },
16973   {
16974     "type": "get",
16975     "url": "/api/mail/messages/describe",
16976     "title": "Gets table info about Messages",
16977     "examples": [
16978       {
16979         "title": "Example usage:",
16980         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16981         "type": "json"
16982       }
16983     ],
16984     "name": "DescribeMessages",
16985     "group": "Mail_Messages",
16986     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16987     "version": "0.0.0",
16988     "filename": "server/api/mailMessage/index.js",
16989     "groupTitle": "Mail_Messages"
16990   },
16991   {
16992     "type": "get",
16993     "url": "/api/mail/messages",
16994     "title": "Gets a list of Messages",
16995     "examples": [
16996       {
16997         "title": "Example usage:",
16998         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16999         "type": "json"
17000       }
17001     ],
17002     "name": "GetMessages",
17003     "group": "Mail_Messages",
17004     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17005     "version": "0.0.0",
17006     "filename": "server/api/mailMessage/index.js",
17007     "groupTitle": "Mail_Messages"
17008   },
17009   {
17010     "type": "get",
17011     "url": "/api/mail/messages/{id}",
17012     "title": "Gets a single Message",
17013     "examples": [
17014       {
17015         "title": "Example usage:",
17016         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
17017         "type": "json"
17018       }
17019     ],
17020     "name": "ShowMessages",
17021     "group": "Mail_Messages",
17022     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17023     "version": "0.0.0",
17024     "filename": "server/api/mailMessage/index.js",
17025     "groupTitle": "Mail_Messages"
17026   },
17027   {
17028     "type": "put",
17029     "url": "/api/mail/messages/{id}/accept",
17030     "title": "Accepts message",
17031     "examples": [
17032       {
17033         "title": "Example usage:",
17034         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17035         "type": "json"
17036       }
17037     ],
17038     "name": "acceptMessage",
17039     "group": "Mail_Messages",
17040     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17041     "version": "0.0.0",
17042     "filename": "server/api/mailMessage/index.js",
17043     "groupTitle": "Mail_Messages"
17044   },
17045   {
17046     "type": "post",
17047     "url": "/api/mail/messages",
17048     "title": "Create a message",
17049     "examples": [
17050       {
17051         "title": "Example usage:",
17052         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17053         "type": "json"
17054       }
17055     ],
17056     "name": "createMessage",
17057     "group": "Mail_Messages",
17058     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17059     "version": "0.0.0",
17060     "filename": "server/api/mailMessage/index.js",
17061     "groupTitle": "Mail_Messages"
17062   },
17063   {
17064     "type": "get",
17065     "url": "/api/mail/messages/{id}/download",
17066     "title": "Gets message",
17067     "examples": [
17068       {
17069         "title": "Example usage:",
17070         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
17071         "type": "json"
17072       }
17073     ],
17074     "name": "download",
17075     "group": "Mail_Messages",
17076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17077     "version": "0.0.0",
17078     "filename": "server/api/mailMessage/index.js",
17079     "groupTitle": "Mail_Messages"
17080   },
17081   {
17082     "type": "put",
17083     "url": "/api/mail/messages/{id}/reject",
17084     "title": "Rejects message",
17085     "examples": [
17086       {
17087         "title": "Example usage:",
17088         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17089         "type": "json"
17090       }
17091     ],
17092     "name": "rejectMessage",
17093     "group": "Mail_Messages",
17094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17095     "version": "0.0.0",
17096     "filename": "server/api/mailMessage/index.js",
17097     "groupTitle": "Mail_Messages"
17098   },
17099   {
17100     "type": "put",
17101     "url": "/api/mail/messages/{id}",
17102     "title": "Update an existing Message",
17103     "examples": [
17104       {
17105         "title": "Example usage:",
17106         "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",
17107         "type": "json"
17108       }
17109     ],
17110     "name": "updateMessages",
17111     "group": "Mail_Messages",
17112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17113     "version": "0.0.0",
17114     "filename": "server/api/mailMessage/index.js",
17115     "groupTitle": "Mail_Messages"
17116   },
17117   {
17118     "type": "post",
17119     "url": "/api/mail/reports/queue",
17120     "title": "Creates a new Mail Queue Report",
17121     "examples": [
17122       {
17123         "title": "Example usage:",
17124         "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",
17125         "type": "json"
17126       }
17127     ],
17128     "name": "CreateMail_Queue_Reports",
17129     "group": "Mail_Queue_Reports",
17130     "parameter": {
17131       "fields": {
17132         "Body": [
17133           {
17134             "group": "Body",
17135             "type": "String",
17136             "optional": false,
17137             "field": "uniqueid",
17138             "description": ""
17139           },
17140           {
17141             "group": "Body",
17142             "type": "String",
17143             "optional": true,
17144             "field": "from",
17145             "description": ""
17146           },
17147           {
17148             "group": "Body",
17149             "type": "String",
17150             "optional": true,
17151             "field": "joinAt",
17152             "description": ""
17153           },
17154           {
17155             "group": "Body",
17156             "type": "String",
17157             "optional": true,
17158             "field": "leaveAt",
17159             "description": ""
17160           },
17161           {
17162             "group": "Body",
17163             "type": "String",
17164             "optional": true,
17165             "field": "acceptAt",
17166             "description": ""
17167           },
17168           {
17169             "group": "Body",
17170             "type": "String",
17171             "optional": true,
17172             "field": "exitAt",
17173             "description": ""
17174           },
17175           {
17176             "group": "Body",
17177             "type": "String",
17178             "optional": true,
17179             "field": "reason",
17180             "description": ""
17181           }
17182         ]
17183       }
17184     },
17185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17186     "version": "0.0.0",
17187     "filename": "server/api/mailQueueReport/index.js",
17188     "groupTitle": "Mail_Queue_Reports"
17189   },
17190   {
17191     "type": "delete",
17192     "url": "/api/mail/reports/queue/{id}",
17193     "title": "Deletes a Mail Queue Report",
17194     "examples": [
17195       {
17196         "title": "Example usage:",
17197         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
17198         "type": "json"
17199       }
17200     ],
17201     "name": "DeleteMail_Queue_Reports",
17202     "group": "Mail_Queue_Reports",
17203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17204     "version": "0.0.0",
17205     "filename": "server/api/mailQueueReport/index.js",
17206     "groupTitle": "Mail_Queue_Reports"
17207   },
17208   {
17209     "type": "get",
17210     "url": "/api/mail/reports/queue/describe",
17211     "title": "Gets table info about Mail Queue Reports",
17212     "examples": [
17213       {
17214         "title": "Example usage:",
17215         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
17216         "type": "json"
17217       }
17218     ],
17219     "name": "DescribeMail_Queue_Reports",
17220     "group": "Mail_Queue_Reports",
17221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17222     "version": "0.0.0",
17223     "filename": "server/api/mailQueueReport/index.js",
17224     "groupTitle": "Mail_Queue_Reports"
17225   },
17226   {
17227     "type": "get",
17228     "url": "/api/mail/reports/queue",
17229     "title": "Gets a list of Mail Queue Reports",
17230     "examples": [
17231       {
17232         "title": "Example usage:",
17233         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
17234         "type": "json"
17235       }
17236     ],
17237     "name": "GetMail_Queue_Reports",
17238     "group": "Mail_Queue_Reports",
17239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17240     "version": "0.0.0",
17241     "filename": "server/api/mailQueueReport/index.js",
17242     "groupTitle": "Mail_Queue_Reports"
17243   },
17244   {
17245     "type": "get",
17246     "url": "/api/mail/reports/queue/{id}",
17247     "title": "Gets a single Mail Queue Report",
17248     "examples": [
17249       {
17250         "title": "Example usage:",
17251         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17252         "type": "json"
17253       }
17254     ],
17255     "name": "ShowMail_Queue_Reports",
17256     "group": "Mail_Queue_Reports",
17257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17258     "version": "0.0.0",
17259     "filename": "server/api/mailQueueReport/index.js",
17260     "groupTitle": "Mail_Queue_Reports"
17261   },
17262   {
17263     "type": "put",
17264     "url": "/api/mail/reports/queue/{id}",
17265     "title": "Update an existing Mail Queue Report",
17266     "examples": [
17267       {
17268         "title": "Example usage:",
17269         "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",
17270         "type": "json"
17271       }
17272     ],
17273     "name": "updateMail_Queue_Reports",
17274     "group": "Mail_Queue_Reports",
17275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17276     "version": "0.0.0",
17277     "filename": "server/api/mailQueueReport/index.js",
17278     "groupTitle": "Mail_Queue_Reports"
17279   },
17280   {
17281     "type": "post",
17282     "url": "/api/mail/queues/{id}/users",
17283     "title": "Add agents to a queue",
17284     "examples": [
17285       {
17286         "title": "Example usage:",
17287         "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",
17288         "type": "json"
17289       }
17290     ],
17291     "name": "AddAgents",
17292     "group": "Mail_Queues",
17293     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17294     "version": "0.0.0",
17295     "filename": "server/api/mailQueue/index.js",
17296     "groupTitle": "Mail_Queues"
17297   },
17298   {
17299     "type": "post",
17300     "url": "/api/mail/queues/{id}/teams",
17301     "title": "Add teams to a queue",
17302     "examples": [
17303       {
17304         "title": "Example usage:",
17305         "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",
17306         "type": "json"
17307       }
17308     ],
17309     "name": "AddTeams",
17310     "group": "Mail_Queues",
17311     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17312     "version": "0.0.0",
17313     "filename": "server/api/mailQueue/index.js",
17314     "groupTitle": "Mail_Queues"
17315   },
17316   {
17317     "type": "post",
17318     "url": "/api/mail/queues",
17319     "title": "Creates a new Queue",
17320     "examples": [
17321       {
17322         "title": "Example usage:",
17323         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17324         "type": "json"
17325       }
17326     ],
17327     "name": "CreateQueues",
17328     "group": "Mail_Queues",
17329     "parameter": {
17330       "fields": {
17331         "Body": [
17332           {
17333             "group": "Body",
17334             "type": "String",
17335             "optional": true,
17336             "field": "name",
17337             "description": ""
17338           },
17339           {
17340             "group": "Body",
17341             "type": "String",
17342             "optional": true,
17343             "field": "description",
17344             "description": ""
17345           },
17346           {
17347             "group": "Body",
17348             "type": "Integer",
17349             "optional": true,
17350             "field": "timeout",
17351             "description": ""
17352           },
17353           {
17354             "group": "Body",
17355             "type": "String",
17356             "allowedValues": [
17357               "\"rrmemory\"",
17358               "\"beepall\"",
17359               "\"roundrobin\""
17360             ],
17361             "optional": true,
17362             "field": "strategy",
17363             "description": ""
17364           }
17365         ]
17366       }
17367     },
17368     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17369     "version": "0.0.0",
17370     "filename": "server/api/mailQueue/index.js",
17371     "groupTitle": "Mail_Queues"
17372   },
17373   {
17374     "type": "delete",
17375     "url": "/api/mail/queues/{id}",
17376     "title": "Deletes a Queue",
17377     "examples": [
17378       {
17379         "title": "Example usage:",
17380         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17381         "type": "json"
17382       }
17383     ],
17384     "name": "DeleteQueues",
17385     "group": "Mail_Queues",
17386     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17387     "version": "0.0.0",
17388     "filename": "server/api/mailQueue/index.js",
17389     "groupTitle": "Mail_Queues"
17390   },
17391   {
17392     "type": "get",
17393     "url": "/api/mail/queues/describe",
17394     "title": "Gets table info about Queues",
17395     "examples": [
17396       {
17397         "title": "Example usage:",
17398         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17399         "type": "json"
17400       }
17401     ],
17402     "name": "DescribeQueues",
17403     "group": "Mail_Queues",
17404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17405     "version": "0.0.0",
17406     "filename": "server/api/mailQueue/index.js",
17407     "groupTitle": "Mail_Queues"
17408   },
17409   {
17410     "type": "get",
17411     "url": "/api/mail/queues/{id}/users",
17412     "title": "Gets queue agents",
17413     "examples": [
17414       {
17415         "title": "Example usage:",
17416         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17417         "type": "json"
17418       }
17419     ],
17420     "name": "GetAgents",
17421     "group": "Mail_Queues",
17422     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17423     "version": "0.0.0",
17424     "filename": "server/api/mailQueue/index.js",
17425     "groupTitle": "Mail_Queues"
17426   },
17427   {
17428     "type": "get",
17429     "url": "/api/mail/queues/{id}/members",
17430     "title": "GetMembers",
17431     "examples": [
17432       {
17433         "title": "Example usage:",
17434         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
17435         "type": "json"
17436       }
17437     ],
17438     "name": "GetMembers",
17439     "group": "Mail_Queues",
17440     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17441     "version": "0.0.0",
17442     "filename": "server/api/mailQueue/index.js",
17443     "groupTitle": "Mail_Queues"
17444   },
17445   {
17446     "type": "get",
17447     "url": "/api/mail/queues",
17448     "title": "Gets a list of Queues",
17449     "examples": [
17450       {
17451         "title": "Example usage:",
17452         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17453         "type": "json"
17454       }
17455     ],
17456     "name": "GetQueues",
17457     "group": "Mail_Queues",
17458     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17459     "version": "0.0.0",
17460     "filename": "server/api/mailQueue/index.js",
17461     "groupTitle": "Mail_Queues"
17462   },
17463   {
17464     "type": "get",
17465     "url": "/api/mail/queues/{id}/teams",
17466     "title": "Gets queues list",
17467     "examples": [
17468       {
17469         "title": "Example usage:",
17470         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17471         "type": "json"
17472       }
17473     ],
17474     "name": "GetTeams",
17475     "group": "Mail_Queues",
17476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17477     "version": "0.0.0",
17478     "filename": "server/api/mailQueue/index.js",
17479     "groupTitle": "Mail_Queues"
17480   },
17481   {
17482     "type": "delete",
17483     "url": "/api/mail/queues/{id}/users",
17484     "title": "Removes agents from a queue",
17485     "examples": [
17486       {
17487         "title": "Example usage:",
17488         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17489         "type": "json"
17490       }
17491     ],
17492     "name": "RemoveAgents",
17493     "group": "Mail_Queues",
17494     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17495     "version": "0.0.0",
17496     "filename": "server/api/mailQueue/index.js",
17497     "groupTitle": "Mail_Queues"
17498   },
17499   {
17500     "type": "get",
17501     "url": "/api/mail/queues/{id}",
17502     "title": "Gets a single Queue",
17503     "examples": [
17504       {
17505         "title": "Example usage:",
17506         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17507         "type": "json"
17508       }
17509     ],
17510     "name": "ShowQueues",
17511     "group": "Mail_Queues",
17512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17513     "version": "0.0.0",
17514     "filename": "server/api/mailQueue/index.js",
17515     "groupTitle": "Mail_Queues"
17516   },
17517   {
17518     "type": "put",
17519     "url": "/api/mail/queues/{id}",
17520     "title": "Update an existing Queue",
17521     "examples": [
17522       {
17523         "title": "Example usage:",
17524         "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",
17525         "type": "json"
17526       }
17527     ],
17528     "name": "updateQueues",
17529     "group": "Mail_Queues",
17530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17531     "version": "0.0.0",
17532     "filename": "server/api/mailQueue/index.js",
17533     "groupTitle": "Mail_Queues"
17534   },
17535   {
17536     "type": "post",
17537     "url": "/api/mail/out_servers",
17538     "title": "Creates a new SMTP",
17539     "examples": [
17540       {
17541         "title": "Example usage:",
17542         "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",
17543         "type": "json"
17544       }
17545     ],
17546     "name": "CreateSMTPs",
17547     "group": "Mail_SMTP",
17548     "parameter": {
17549       "fields": {
17550         "Body": [
17551           {
17552             "group": "Body",
17553             "type": "String",
17554             "optional": true,
17555             "field": "description",
17556             "description": ""
17557           },
17558           {
17559             "group": "Body",
17560             "type": "String",
17561             "optional": true,
17562             "field": "host",
17563             "description": ""
17564           },
17565           {
17566             "group": "Body",
17567             "type": "String",
17568             "optional": true,
17569             "field": "user",
17570             "description": ""
17571           },
17572           {
17573             "group": "Body",
17574             "type": "String",
17575             "optional": true,
17576             "field": "pass",
17577             "description": ""
17578           },
17579           {
17580             "group": "Body",
17581             "type": "Integer",
17582             "optional": true,
17583             "field": "port",
17584             "description": ""
17585           },
17586           {
17587             "group": "Body",
17588             "type": "Boolean",
17589             "optional": true,
17590             "field": "secure",
17591             "description": ""
17592           },
17593           {
17594             "group": "Body",
17595             "type": "String",
17596             "optional": true,
17597             "field": "service",
17598             "description": ""
17599           },
17600           {
17601             "group": "Body",
17602             "type": "Boolean",
17603             "optional": true,
17604             "field": "authentication",
17605             "description": ""
17606           }
17607         ]
17608       }
17609     },
17610     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17611     "version": "0.0.0",
17612     "filename": "server/api/mailServerOut/index.js",
17613     "groupTitle": "Mail_SMTP"
17614   },
17615   {
17616     "type": "delete",
17617     "url": "/api/mail/out_servers/{id}",
17618     "title": "Deletes a SMTP",
17619     "examples": [
17620       {
17621         "title": "Example usage:",
17622         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17623         "type": "json"
17624       }
17625     ],
17626     "name": "DeleteSMTPs",
17627     "group": "Mail_SMTP",
17628     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17629     "version": "0.0.0",
17630     "filename": "server/api/mailServerOut/index.js",
17631     "groupTitle": "Mail_SMTP"
17632   },
17633   {
17634     "type": "get",
17635     "url": "/api/mail/out_servers",
17636     "title": "Gets a list of SMTPs",
17637     "examples": [
17638       {
17639         "title": "Example usage:",
17640         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17641         "type": "json"
17642       }
17643     ],
17644     "name": "GetSMTPs",
17645     "group": "Mail_SMTP",
17646     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17647     "version": "0.0.0",
17648     "filename": "server/api/mailServerOut/index.js",
17649     "groupTitle": "Mail_SMTP"
17650   },
17651   {
17652     "type": "get",
17653     "url": "/api/mail/out_servers/{id}",
17654     "title": "Gets a single SMTP",
17655     "examples": [
17656       {
17657         "title": "Example usage:",
17658         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17659         "type": "json"
17660       }
17661     ],
17662     "name": "ShowSMTPs",
17663     "group": "Mail_SMTP",
17664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17665     "version": "0.0.0",
17666     "filename": "server/api/mailServerOut/index.js",
17667     "groupTitle": "Mail_SMTP"
17668   },
17669   {
17670     "type": "put",
17671     "url": "/api/mail/out_servers/{id}",
17672     "title": "Update an existing SMTP",
17673     "examples": [
17674       {
17675         "title": "Example usage:",
17676         "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",
17677         "type": "json"
17678       }
17679     ],
17680     "name": "updateSMTPs",
17681     "group": "Mail_SMTP",
17682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17683     "version": "0.0.0",
17684     "filename": "server/api/mailServerOut/index.js",
17685     "groupTitle": "Mail_SMTP"
17686   },
17687   {
17688     "type": "post",
17689     "url": "/api/mail/substatuses",
17690     "title": "Creates a new Queue",
17691     "examples": [
17692       {
17693         "title": "Example usage:",
17694         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17695         "type": "json"
17696       }
17697     ],
17698     "name": "CreateSubstatuses",
17699     "group": "Mail_Substatuses",
17700     "parameter": {
17701       "fields": {
17702         "Body": [
17703           {
17704             "group": "Body",
17705             "type": "String",
17706             "optional": false,
17707             "field": "name",
17708             "description": ""
17709           },
17710           {
17711             "group": "Body",
17712             "type": "String",
17713             "optional": true,
17714             "field": "description",
17715             "description": ""
17716           }
17717         ]
17718       }
17719     },
17720     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17721     "version": "0.0.0",
17722     "filename": "server/api/mailSubstatus/index.js",
17723     "groupTitle": "Mail_Substatuses"
17724   },
17725   {
17726     "type": "delete",
17727     "url": "/api/mail/substatuses/{id}",
17728     "title": "Deletes a Queue",
17729     "examples": [
17730       {
17731         "title": "Example usage:",
17732         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17733         "type": "json"
17734       }
17735     ],
17736     "name": "DeleteSubstatuses",
17737     "group": "Mail_Substatuses",
17738     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17739     "version": "0.0.0",
17740     "filename": "server/api/mailSubstatus/index.js",
17741     "groupTitle": "Mail_Substatuses"
17742   },
17743   {
17744     "type": "get",
17745     "url": "/api/mail/substatuses/describe",
17746     "title": "Gets table info about Substatuses",
17747     "examples": [
17748       {
17749         "title": "Example usage:",
17750         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17751         "type": "json"
17752       }
17753     ],
17754     "name": "DescribeSubstatuses",
17755     "group": "Mail_Substatuses",
17756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17757     "version": "0.0.0",
17758     "filename": "server/api/mailSubstatus/index.js",
17759     "groupTitle": "Mail_Substatuses"
17760   },
17761   {
17762     "type": "get",
17763     "url": "/api/mail/substatuses",
17764     "title": "Gets a list of Substatuses",
17765     "examples": [
17766       {
17767         "title": "Example usage:",
17768         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17769         "type": "json"
17770       }
17771     ],
17772     "name": "GetSubstatuses",
17773     "group": "Mail_Substatuses",
17774     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17775     "version": "0.0.0",
17776     "filename": "server/api/mailSubstatus/index.js",
17777     "groupTitle": "Mail_Substatuses"
17778   },
17779   {
17780     "type": "get",
17781     "url": "/api/mail/substatuses/{id}",
17782     "title": "Gets a single Queue",
17783     "examples": [
17784       {
17785         "title": "Example usage:",
17786         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17787         "type": "json"
17788       }
17789     ],
17790     "name": "ShowSubstatuses",
17791     "group": "Mail_Substatuses",
17792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17793     "version": "0.0.0",
17794     "filename": "server/api/mailSubstatus/index.js",
17795     "groupTitle": "Mail_Substatuses"
17796   },
17797   {
17798     "type": "put",
17799     "url": "/api/mail/substatuses/{id}",
17800     "title": "Update an existing Queue",
17801     "examples": [
17802       {
17803         "title": "Example usage:",
17804         "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",
17805         "type": "json"
17806       }
17807     ],
17808     "name": "updateSubstatuses",
17809     "group": "Mail_Substatuses",
17810     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17811     "version": "0.0.0",
17812     "filename": "server/api/mailSubstatus/index.js",
17813     "groupTitle": "Mail_Substatuses"
17814   },
17815   {
17816     "type": "post",
17817     "url": "/api/mail/reports/transfer",
17818     "title": "Creates a new Mail Transfer Report",
17819     "examples": [
17820       {
17821         "title": "Example usage:",
17822         "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",
17823         "type": "json"
17824       }
17825     ],
17826     "name": "CreateMail_Transfer_Reports",
17827     "group": "Mail_Transfer_Reports",
17828     "parameter": {
17829       "fields": {
17830         "Body": [
17831           {
17832             "group": "Body",
17833             "type": "String",
17834             "optional": false,
17835             "field": "uniqueid",
17836             "description": ""
17837           },
17838           {
17839             "group": "Body",
17840             "type": "String",
17841             "allowedValues": [
17842               "\"account\"",
17843               "\"agent\"",
17844               "\"queue\""
17845             ],
17846             "optional": false,
17847             "field": "type",
17848             "description": ""
17849           },
17850           {
17851             "group": "Body",
17852             "type": "String",
17853             "optional": false,
17854             "field": "transferredAt",
17855             "description": ""
17856           }
17857         ]
17858       }
17859     },
17860     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17861     "version": "0.0.0",
17862     "filename": "server/api/mailTransferReport/index.js",
17863     "groupTitle": "Mail_Transfer_Reports"
17864   },
17865   {
17866     "type": "delete",
17867     "url": "/api/mail/reports/transfer/{id}",
17868     "title": "Deletes a Mail Transfer Report",
17869     "examples": [
17870       {
17871         "title": "Example usage:",
17872         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17873         "type": "json"
17874       }
17875     ],
17876     "name": "DeleteMail_Transfer_Reports",
17877     "group": "Mail_Transfer_Reports",
17878     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17879     "version": "0.0.0",
17880     "filename": "server/api/mailTransferReport/index.js",
17881     "groupTitle": "Mail_Transfer_Reports"
17882   },
17883   {
17884     "type": "get",
17885     "url": "/api/mail/reports/transfer/describe",
17886     "title": "Gets table info about Mail Transfer Reports",
17887     "examples": [
17888       {
17889         "title": "Example usage:",
17890         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17891         "type": "json"
17892       }
17893     ],
17894     "name": "DescribeMail_Transfer_Reports",
17895     "group": "Mail_Transfer_Reports",
17896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17897     "version": "0.0.0",
17898     "filename": "server/api/mailTransferReport/index.js",
17899     "groupTitle": "Mail_Transfer_Reports"
17900   },
17901   {
17902     "type": "get",
17903     "url": "/api/mail/reports/transfer",
17904     "title": "Gets a list of Mail Transfer Reports",
17905     "examples": [
17906       {
17907         "title": "Example usage:",
17908         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17909         "type": "json"
17910       }
17911     ],
17912     "name": "GetMail_Transfer_Reports",
17913     "group": "Mail_Transfer_Reports",
17914     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17915     "version": "0.0.0",
17916     "filename": "server/api/mailTransferReport/index.js",
17917     "groupTitle": "Mail_Transfer_Reports"
17918   },
17919   {
17920     "type": "get",
17921     "url": "/api/mail/reports/transfer/{id}",
17922     "title": "Gets a single Mail Transfer Report",
17923     "examples": [
17924       {
17925         "title": "Example usage:",
17926         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17927         "type": "json"
17928       }
17929     ],
17930     "name": "ShowMail_Transfer_Reports",
17931     "group": "Mail_Transfer_Reports",
17932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17933     "version": "0.0.0",
17934     "filename": "server/api/mailTransferReport/index.js",
17935     "groupTitle": "Mail_Transfer_Reports"
17936   },
17937   {
17938     "type": "put",
17939     "url": "/api/mail/reports/transfer/{id}",
17940     "title": "Update an existing Mail Transfer Report",
17941     "examples": [
17942       {
17943         "title": "Example usage:",
17944         "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",
17945         "type": "json"
17946       }
17947     ],
17948     "name": "updateMail_Transfer_Reports",
17949     "group": "Mail_Transfer_Reports",
17950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17951     "version": "0.0.0",
17952     "filename": "server/api/mailTransferReport/index.js",
17953     "groupTitle": "Mail_Transfer_Reports"
17954   },
17955   {
17956     "type": "get",
17957     "url": "/api/members/reports/describe",
17958     "title": "Gets table info about Member Reports",
17959     "examples": [
17960       {
17961         "title": "Example usage:",
17962         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17963         "type": "json"
17964       }
17965     ],
17966     "name": "DescribeMember_Reports",
17967     "group": "Member_Reports",
17968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17969     "version": "0.0.0",
17970     "filename": "server/api/memberReport/index.js",
17971     "groupTitle": "Member_Reports"
17972   },
17973   {
17974     "type": "get",
17975     "url": "/api/members/reports",
17976     "title": "Gets a list of Member Reports",
17977     "examples": [
17978       {
17979         "title": "Example usage:",
17980         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17981         "type": "json"
17982       }
17983     ],
17984     "name": "GetMember_Reports",
17985     "group": "Member_Reports",
17986     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17987     "version": "0.0.0",
17988     "filename": "server/api/memberReport/index.js",
17989     "groupTitle": "Member_Reports"
17990   },
17991   {
17992     "type": "get",
17993     "url": "/api/members/reports/{id}",
17994     "title": "Gets a single Member Report",
17995     "examples": [
17996       {
17997         "title": "Example usage:",
17998         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17999         "type": "json"
18000       }
18001     ],
18002     "name": "ShowMember_Reports",
18003     "group": "Member_Reports",
18004     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18005     "version": "0.0.0",
18006     "filename": "server/api/memberReport/index.js",
18007     "groupTitle": "Member_Reports"
18008   },
18009   {
18010     "type": "get",
18011     "url": "/api/migrations",
18012     "title": "Gets a list of Migrations",
18013     "examples": [
18014       {
18015         "title": "Example usage:",
18016         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
18017         "type": "json"
18018       }
18019     ],
18020     "name": "GetMigrations",
18021     "group": "Migrations",
18022     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18023     "version": "0.0.0",
18024     "filename": "server/api/migration/index.js",
18025     "groupTitle": "Migrations"
18026   },
18027   {
18028     "type": "post",
18029     "url": "/api/voice/networks",
18030     "title": "Create a new network",
18031     "examples": [
18032       {
18033         "title": "Example usage:",
18034         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18035         "type": "json"
18036       }
18037     ],
18038     "name": "Create",
18039     "group": "Networks",
18040     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18041     "version": "0.0.0",
18042     "filename": "server/api/network/index.js",
18043     "groupTitle": "Networks"
18044   },
18045   {
18046     "type": "delete",
18047     "url": "/api/voice/networks/{id}",
18048     "title": "Deletes a network",
18049     "examples": [
18050       {
18051         "title": "Example usage:",
18052         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
18053         "type": "json"
18054       }
18055     ],
18056     "name": "Delete",
18057     "group": "Networks",
18058     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18059     "version": "0.0.0",
18060     "filename": "server/api/network/index.js",
18061     "groupTitle": "Networks"
18062   },
18063   {
18064     "type": "get",
18065     "url": "/api/networks",
18066     "title": "Gets a list of Networks",
18067     "examples": [
18068       {
18069         "title": "Example usage:",
18070         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
18071         "type": "json"
18072       }
18073     ],
18074     "name": "GetNetworks",
18075     "group": "Networks",
18076     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18077     "version": "0.0.0",
18078     "filename": "server/api/network/index.js",
18079     "groupTitle": "Networks"
18080   },
18081   {
18082     "type": "get",
18083     "url": "/api/networks/{id}",
18084     "title": "Gets a single Network",
18085     "examples": [
18086       {
18087         "title": "Example usage:",
18088         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
18089         "type": "json"
18090       }
18091     ],
18092     "name": "ShowNetworks",
18093     "group": "Networks",
18094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18095     "version": "0.0.0",
18096     "filename": "server/api/network/index.js",
18097     "groupTitle": "Networks"
18098   },
18099   {
18100     "type": "put",
18101     "url": "/api/voice/networks/{id}",
18102     "title": "Update an existing network",
18103     "examples": [
18104       {
18105         "title": "Example usage:",
18106         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
18107         "type": "json"
18108       }
18109     ],
18110     "name": "Update",
18111     "group": "Networks",
18112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18113     "version": "0.0.0",
18114     "filename": "server/api/network/index.js",
18115     "groupTitle": "Networks"
18116   },
18117   {
18118     "type": "post",
18119     "url": "/api/openchannel/accounts/{id}/users",
18120     "title": "Add agents to a openchannel account",
18121     "examples": [
18122       {
18123         "title": "Example usage:",
18124         "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",
18125         "type": "json"
18126       }
18127     ],
18128     "name": "AddAgents",
18129     "group": "Openchannel_Accounts",
18130     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18131     "version": "0.0.0",
18132     "filename": "server/api/openchannelAccount/index.js",
18133     "groupTitle": "Openchannel_Accounts"
18134   },
18135   {
18136     "type": "post",
18137     "url": "/api/openchannel/accounts",
18138     "title": "Creates a new Account",
18139     "examples": [
18140       {
18141         "title": "Example usage:",
18142         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18143         "type": "json"
18144       }
18145     ],
18146     "name": "CreateAccounts",
18147     "group": "Openchannel_Accounts",
18148     "parameter": {
18149       "fields": {
18150         "Body": [
18151           {
18152             "group": "Body",
18153             "type": "String",
18154             "optional": false,
18155             "field": "name",
18156             "description": ""
18157           },
18158           {
18159             "group": "Body",
18160             "type": "String",
18161             "optional": true,
18162             "field": "description",
18163             "description": ""
18164           },
18165           {
18166             "group": "Body",
18167             "type": "String",
18168             "optional": true,
18169             "field": "token",
18170             "description": ""
18171           },
18172           {
18173             "group": "Body",
18174             "type": "String",
18175             "optional": true,
18176             "field": "replyUri",
18177             "description": ""
18178           },
18179           {
18180             "group": "Body",
18181             "type": "String",
18182             "optional": false,
18183             "field": "key",
18184             "description": ""
18185           },
18186           {
18187             "group": "Body",
18188             "type": "Text",
18189             "optional": true,
18190             "field": "notificationTemplate",
18191             "description": ""
18192           },
18193           {
18194             "group": "Body",
18195             "type": "Boolean",
18196             "optional": true,
18197             "field": "notificationSound",
18198             "description": ""
18199           },
18200           {
18201             "group": "Body",
18202             "type": "Boolean",
18203             "optional": true,
18204             "field": "notificationShake",
18205             "description": ""
18206           },
18207           {
18208             "group": "Body",
18209             "type": "Integer",
18210             "optional": true,
18211             "field": "waitForTheAssignedAgent",
18212             "description": ""
18213           },
18214           {
18215             "group": "Body",
18216             "type": "Integer",
18217             "optional": true,
18218             "field": "waitForTheAssignedQueue",
18219             "description": ""
18220           },
18221           {
18222             "group": "Body",
18223             "type": "String",
18224             "optional": true,
18225             "field": "mapKey",
18226             "description": ""
18227           },
18228           {
18229             "group": "Body",
18230             "type": "Boolean",
18231             "optional": true,
18232             "field": "queueTransfer",
18233             "description": ""
18234           },
18235           {
18236             "group": "Body",
18237             "type": "Integer",
18238             "optional": true,
18239             "field": "queueTransferTimeout",
18240             "description": ""
18241           },
18242           {
18243             "group": "Body",
18244             "type": "Boolean",
18245             "optional": true,
18246             "field": "agentTransfer",
18247             "description": ""
18248           },
18249           {
18250             "group": "Body",
18251             "type": "Integer",
18252             "optional": true,
18253             "field": "agentTransferTimeout",
18254             "description": ""
18255           },
18256           {
18257             "group": "Body",
18258             "type": "Integer",
18259             "optional": true,
18260             "field": "mandatoryDispositionPauseId",
18261             "description": "<p>Status to put when mandatory disposition is enabled</p>"
18262           },
18263           {
18264             "group": "Body",
18265             "type": "Boolean",
18266             "optional": true,
18267             "field": "mandatoryDisposition",
18268             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18269           }
18270         ]
18271       }
18272     },
18273     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18274     "version": "0.0.0",
18275     "filename": "server/api/openchannelAccount/index.js",
18276     "groupTitle": "Openchannel_Accounts"
18277   },
18278   {
18279     "type": "delete",
18280     "url": "/api/openchannel/accounts/{id}",
18281     "title": "Deletes a Account",
18282     "examples": [
18283       {
18284         "title": "Example usage:",
18285         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18286         "type": "json"
18287       }
18288     ],
18289     "name": "DeleteAccounts",
18290     "group": "Openchannel_Accounts",
18291     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18292     "version": "0.0.0",
18293     "filename": "server/api/openchannelAccount/index.js",
18294     "groupTitle": "Openchannel_Accounts"
18295   },
18296   {
18297     "type": "get",
18298     "url": "/api/openchannel/accounts/describe",
18299     "title": "Gets table info about Accounts",
18300     "examples": [
18301       {
18302         "title": "Example usage:",
18303         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18304         "type": "json"
18305       }
18306     ],
18307     "name": "DescribeAccounts",
18308     "group": "Openchannel_Accounts",
18309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18310     "version": "0.0.0",
18311     "filename": "server/api/openchannelAccount/index.js",
18312     "groupTitle": "Openchannel_Accounts"
18313   },
18314   {
18315     "type": "get",
18316     "url": "/api/openchannel/accounts",
18317     "title": "Gets a list of Accounts",
18318     "examples": [
18319       {
18320         "title": "Example usage:",
18321         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18322         "type": "json"
18323       }
18324     ],
18325     "name": "GetAccounts",
18326     "group": "Openchannel_Accounts",
18327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18328     "version": "0.0.0",
18329     "filename": "server/api/openchannelAccount/index.js",
18330     "groupTitle": "Openchannel_Accounts"
18331   },
18332   {
18333     "type": "get",
18334     "url": "/api/openchannel/accounts/{id}/users",
18335     "title": "Gets agents from openchannel account",
18336     "examples": [
18337       {
18338         "title": "Example usage:",
18339         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18340         "type": "json"
18341       }
18342     ],
18343     "name": "GetAgents",
18344     "group": "Openchannel_Accounts",
18345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18346     "version": "0.0.0",
18347     "filename": "server/api/openchannelAccount/index.js",
18348     "groupTitle": "Openchannel_Accounts"
18349   },
18350   {
18351     "type": "delete",
18352     "url": "/api/openchannel/accounts/{id}/users",
18353     "title": "Removes agents from a openchannel account",
18354     "examples": [
18355       {
18356         "title": "Example usage:",
18357         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18358         "type": "json"
18359       }
18360     ],
18361     "name": "RemoveAgents",
18362     "group": "Openchannel_Accounts",
18363     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18364     "version": "0.0.0",
18365     "filename": "server/api/openchannelAccount/index.js",
18366     "groupTitle": "Openchannel_Accounts"
18367   },
18368   {
18369     "type": "delete",
18370     "url": "/api/openchannel/accounts/{id}/canned_answers",
18371     "title": "Removes canned answers from account",
18372     "examples": [
18373       {
18374         "title": "Example usage:",
18375         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18376         "type": "json"
18377       }
18378     ],
18379     "name": "RemoveAnswers",
18380     "group": "Openchannel_Accounts",
18381     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18382     "version": "0.0.0",
18383     "filename": "server/api/openchannelAccount/index.js",
18384     "groupTitle": "Openchannel_Accounts"
18385   },
18386   {
18387     "type": "delete",
18388     "url": "/api/openchannel/accounts/{id}/dispositions",
18389     "title": "Removes dispositions from account",
18390     "examples": [
18391       {
18392         "title": "Example usage:",
18393         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18394         "type": "json"
18395       }
18396     ],
18397     "name": "RemoveDispositions",
18398     "group": "Openchannel_Accounts",
18399     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18400     "version": "0.0.0",
18401     "filename": "server/api/openchannelAccount/index.js",
18402     "groupTitle": "Openchannel_Accounts"
18403   },
18404   {
18405     "type": "get",
18406     "url": "/api/openchannel/accounts/{id}",
18407     "title": "Gets a single Account",
18408     "examples": [
18409       {
18410         "title": "Example usage:",
18411         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18412         "type": "json"
18413       }
18414     ],
18415     "name": "ShowAccounts",
18416     "group": "Openchannel_Accounts",
18417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18418     "version": "0.0.0",
18419     "filename": "server/api/openchannelAccount/index.js",
18420     "groupTitle": "Openchannel_Accounts"
18421   },
18422   {
18423     "type": "post",
18424     "url": "/api/openchannel/accounts/{id}/canned_answers",
18425     "title": "Creates new canned answer",
18426     "examples": [
18427       {
18428         "title": "Example usage:",
18429         "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",
18430         "type": "json"
18431       }
18432     ],
18433     "name": "addAnswer",
18434     "group": "Openchannel_Accounts",
18435     "parameter": {
18436       "fields": {
18437         "Body": [
18438           {
18439             "group": "Body",
18440             "type": "String",
18441             "optional": false,
18442             "field": "key",
18443             "description": ""
18444           },
18445           {
18446             "group": "Body",
18447             "type": "Text",
18448             "optional": false,
18449             "field": "value",
18450             "description": ""
18451           },
18452           {
18453             "group": "Body",
18454             "type": "String",
18455             "optional": true,
18456             "field": "description",
18457             "description": ""
18458           },
18459           {
18460             "group": "Body",
18461             "type": "Virtual",
18462             "optional": true,
18463             "field": "name",
18464             "description": ""
18465           }
18466         ]
18467       }
18468     },
18469     "description": "<p>Motion will return a HTTP status code <code>201</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/openchannelAccount/index.js",
18472     "groupTitle": "Openchannel_Accounts"
18473   },
18474   {
18475     "type": "post",
18476     "url": "/api/openchannel/accounts/{id}/applications",
18477     "title": "Creates new applications",
18478     "examples": [
18479       {
18480         "title": "Example usage:",
18481         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18482         "type": "json"
18483       }
18484     ],
18485     "name": "addApplications",
18486     "group": "Openchannel_Accounts",
18487     "parameter": {
18488       "fields": {
18489         "Body": [
18490           {
18491             "group": "Body",
18492             "type": "Integer",
18493             "optional": false,
18494             "field": "priority",
18495             "description": ""
18496           },
18497           {
18498             "group": "Body",
18499             "type": "String",
18500             "optional": false,
18501             "field": "app",
18502             "description": ""
18503           },
18504           {
18505             "group": "Body",
18506             "type": "Text",
18507             "optional": true,
18508             "field": "appdata",
18509             "description": ""
18510           },
18511           {
18512             "group": "Body",
18513             "type": "String",
18514             "optional": true,
18515             "field": "description",
18516             "description": ""
18517           },
18518           {
18519             "group": "Body",
18520             "type": "String",
18521             "optional": true,
18522             "field": "interval",
18523             "description": ""
18524           }
18525         ]
18526       }
18527     },
18528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18529     "version": "0.0.0",
18530     "filename": "server/api/openchannelAccount/index.js",
18531     "groupTitle": "Openchannel_Accounts"
18532   },
18533   {
18534     "type": "post",
18535     "url": "/api/openchannel/accounts/{id}/dispositions",
18536     "title": "Creates new disposition",
18537     "examples": [
18538       {
18539         "title": "Example usage:",
18540         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18541         "type": "json"
18542       }
18543     ],
18544     "name": "addDisposition",
18545     "group": "Openchannel_Accounts",
18546     "parameter": {
18547       "fields": {
18548         "Body": [
18549           {
18550             "group": "Body",
18551             "type": "String",
18552             "optional": false,
18553             "field": "name",
18554             "description": ""
18555           },
18556           {
18557             "group": "Body",
18558             "type": "String",
18559             "allowedValues": [
18560               "\"first\"",
18561               "\"second\"",
18562               "\"third\""
18563             ],
18564             "optional": false,
18565             "field": "level",
18566             "description": ""
18567           },
18568           {
18569             "group": "Body",
18570             "type": "String",
18571             "optional": true,
18572             "field": "description",
18573             "description": ""
18574           }
18575         ]
18576       }
18577     },
18578     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18579     "version": "0.0.0",
18580     "filename": "server/api/openchannelAccount/index.js",
18581     "groupTitle": "Openchannel_Accounts"
18582   },
18583   {
18584     "type": "get",
18585     "url": "/api/openchannel/accounts/{id}/canned_answers",
18586     "title": "Gets account canned answers",
18587     "examples": [
18588       {
18589         "title": "Example usage:",
18590         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18591         "type": "json"
18592       }
18593     ],
18594     "name": "getAnswers",
18595     "group": "Openchannel_Accounts",
18596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18597     "version": "0.0.0",
18598     "filename": "server/api/openchannelAccount/index.js",
18599     "groupTitle": "Openchannel_Accounts"
18600   },
18601   {
18602     "type": "get",
18603     "url": "/api/openchannel/accounts/{id}/applications",
18604     "title": "Gets account applications",
18605     "examples": [
18606       {
18607         "title": "Example usage:",
18608         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18609         "type": "json"
18610       }
18611     ],
18612     "name": "getApplications",
18613     "group": "Openchannel_Accounts",
18614     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18615     "version": "0.0.0",
18616     "filename": "server/api/openchannelAccount/index.js",
18617     "groupTitle": "Openchannel_Accounts"
18618   },
18619   {
18620     "type": "get",
18621     "url": "/api/openchannel/accounts/{id}/dispositions",
18622     "title": "Gets account dispositions",
18623     "examples": [
18624       {
18625         "title": "Example usage:",
18626         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18627         "type": "json"
18628       }
18629     ],
18630     "name": "getDispositions",
18631     "group": "Openchannel_Accounts",
18632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18633     "version": "0.0.0",
18634     "filename": "server/api/openchannelAccount/index.js",
18635     "groupTitle": "Openchannel_Accounts"
18636   },
18637   {
18638     "type": "get",
18639     "url": "/api/openchannel/accounts/{id}/interactions",
18640     "title": "Gets Openchannel Account Interactions",
18641     "examples": [
18642       {
18643         "title": "Example usage:",
18644         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18645         "type": "json"
18646       }
18647     ],
18648     "name": "getInteractions",
18649     "group": "Openchannel_Accounts",
18650     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18651     "version": "0.0.0",
18652     "filename": "server/api/openchannelAccount/index.js",
18653     "groupTitle": "Openchannel_Accounts"
18654   },
18655   {
18656     "type": "post",
18657     "url": "/api/openchannel/accounts/{id}/notify",
18658     "title": "Notify new message",
18659     "examples": [
18660       {
18661         "title": "Example usage:",
18662         "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",
18663         "type": "json"
18664       }
18665     ],
18666     "name": "notify",
18667     "group": "Openchannel_Accounts",
18668     "description": "<p>Motion 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>&lt;a target=&quot;_blank&quot; href=&quot;https://xcally.atlassian.net/wiki/spaces/XMV/pages/1896252245/New+Channels+Configuration+Steps&quot;</a></pre></p>",
18669     "version": "0.0.0",
18670     "filename": "server/api/openchannelAccount/index.js",
18671     "groupTitle": "Openchannel_Accounts"
18672   },
18673   {
18674     "type": "post",
18675     "url": "/api/openchannel/accounts/{id}/send",
18676     "title": "Send new openchannel message",
18677     "examples": [
18678       {
18679         "title": "Example usage:",
18680         "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",
18681         "type": "json"
18682       }
18683     ],
18684     "name": "sendOpenchannel",
18685     "group": "Openchannel_Accounts",
18686     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18687     "version": "0.0.0",
18688     "filename": "server/api/openchannelAccount/index.js",
18689     "groupTitle": "Openchannel_Accounts"
18690   },
18691   {
18692     "type": "put",
18693     "url": "/api/openchannel/accounts/{id}",
18694     "title": "Update an existing Account",
18695     "examples": [
18696       {
18697         "title": "Example usage:",
18698         "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",
18699         "type": "json"
18700       }
18701     ],
18702     "name": "updateAccounts",
18703     "group": "Openchannel_Accounts",
18704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18705     "version": "0.0.0",
18706     "filename": "server/api/openchannelAccount/index.js",
18707     "groupTitle": "Openchannel_Accounts"
18708   },
18709   {
18710     "type": "post",
18711     "url": "/api/openchannel/applications",
18712     "title": "Creates a new Application",
18713     "examples": [
18714       {
18715         "title": "Example usage:",
18716         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18717         "type": "json"
18718       }
18719     ],
18720     "name": "CreateApplications",
18721     "group": "Openchannel_Applications",
18722     "parameter": {
18723       "fields": {
18724         "Body": [
18725           {
18726             "group": "Body",
18727             "type": "Integer",
18728             "optional": false,
18729             "field": "priority",
18730             "description": ""
18731           },
18732           {
18733             "group": "Body",
18734             "type": "String",
18735             "optional": false,
18736             "field": "app",
18737             "description": ""
18738           },
18739           {
18740             "group": "Body",
18741             "type": "Text",
18742             "optional": true,
18743             "field": "appdata",
18744             "description": ""
18745           },
18746           {
18747             "group": "Body",
18748             "type": "String",
18749             "optional": true,
18750             "field": "description",
18751             "description": ""
18752           },
18753           {
18754             "group": "Body",
18755             "type": "String",
18756             "optional": true,
18757             "field": "interval",
18758             "description": ""
18759           }
18760         ]
18761       }
18762     },
18763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18764     "version": "0.0.0",
18765     "filename": "server/api/openchannelApplication/index.js",
18766     "groupTitle": "Openchannel_Applications"
18767   },
18768   {
18769     "type": "delete",
18770     "url": "/api/openchannel/applications/{id}",
18771     "title": "Deletes a Application",
18772     "examples": [
18773       {
18774         "title": "Example usage:",
18775         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18776         "type": "json"
18777       }
18778     ],
18779     "name": "DeleteApplications",
18780     "group": "Openchannel_Applications",
18781     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18782     "version": "0.0.0",
18783     "filename": "server/api/openchannelApplication/index.js",
18784     "groupTitle": "Openchannel_Applications"
18785   },
18786   {
18787     "type": "get",
18788     "url": "/api/openchannel/applications",
18789     "title": "Gets a list of Applications",
18790     "examples": [
18791       {
18792         "title": "Example usage:",
18793         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18794         "type": "json"
18795       }
18796     ],
18797     "name": "GetApplications",
18798     "group": "Openchannel_Applications",
18799     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18800     "version": "0.0.0",
18801     "filename": "server/api/openchannelApplication/index.js",
18802     "groupTitle": "Openchannel_Applications"
18803   },
18804   {
18805     "type": "get",
18806     "url": "/api/openchannel/applications/{id}",
18807     "title": "Gets a single Application",
18808     "examples": [
18809       {
18810         "title": "Example usage:",
18811         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18812         "type": "json"
18813       }
18814     ],
18815     "name": "ShowApplications",
18816     "group": "Openchannel_Applications",
18817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18818     "version": "0.0.0",
18819     "filename": "server/api/openchannelApplication/index.js",
18820     "groupTitle": "Openchannel_Applications"
18821   },
18822   {
18823     "type": "put",
18824     "url": "/api/openchannel/applications/{id}",
18825     "title": "Update an existing Application",
18826     "examples": [
18827       {
18828         "title": "Example usage:",
18829         "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",
18830         "type": "json"
18831       }
18832     ],
18833     "name": "updateApplications",
18834     "group": "Openchannel_Applications",
18835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18836     "version": "0.0.0",
18837     "filename": "server/api/openchannelApplication/index.js",
18838     "groupTitle": "Openchannel_Applications"
18839   },
18840   {
18841     "type": "post",
18842     "url": "/api/openchannel/interactions/{id}/tags",
18843     "title": "Add tags to the interaction",
18844     "examples": [
18845       {
18846         "title": "Example usage:",
18847         "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",
18848         "type": "json"
18849       }
18850     ],
18851     "name": "AddTags",
18852     "group": "Openchannel_Interactions",
18853     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18854     "version": "0.0.0",
18855     "filename": "server/api/openchannelInteraction/index.js",
18856     "groupTitle": "Openchannel_Interactions"
18857   },
18858   {
18859     "type": "post",
18860     "url": "/api/openchannel/interactions",
18861     "title": "Creates a new Interaction",
18862     "examples": [
18863       {
18864         "title": "Example usage:",
18865         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18866         "type": "json"
18867       }
18868     ],
18869     "name": "CreateInteractions",
18870     "group": "Openchannel_Interactions",
18871     "parameter": {
18872       "fields": {
18873         "Body": [
18874           {
18875             "group": "Body",
18876             "type": "Boolean",
18877             "optional": true,
18878             "field": "closed",
18879             "description": ""
18880           },
18881           {
18882             "group": "Body",
18883             "type": "String",
18884             "optional": true,
18885             "field": "closedAt",
18886             "description": ""
18887           },
18888           {
18889             "group": "Body",
18890             "type": "String",
18891             "optional": true,
18892             "field": "disposition",
18893             "description": ""
18894           },
18895           {
18896             "group": "Body",
18897             "type": "String",
18898             "optional": true,
18899             "field": "secondDisposition",
18900             "description": ""
18901           },
18902           {
18903             "group": "Body",
18904             "type": "String",
18905             "optional": true,
18906             "field": "thirdDisposition",
18907             "description": ""
18908           },
18909           {
18910             "group": "Body",
18911             "type": "String",
18912             "optional": true,
18913             "field": "note",
18914             "description": ""
18915           },
18916           {
18917             "group": "Body",
18918             "type": "String",
18919             "optional": true,
18920             "field": "read1stAt",
18921             "description": ""
18922           },
18923           {
18924             "group": "Body",
18925             "type": "String",
18926             "optional": true,
18927             "field": "threadId",
18928             "description": ""
18929           },
18930           {
18931             "group": "Body",
18932             "type": "String",
18933             "optional": true,
18934             "field": "externalUrl",
18935             "description": ""
18936           },
18937           {
18938             "group": "Body",
18939             "type": "String",
18940             "optional": true,
18941             "field": "lastMsgAt",
18942             "description": ""
18943           },
18944           {
18945             "group": "Body",
18946             "type": "String",
18947             "allowedValues": [
18948               "\"in\"",
18949               "\"out\""
18950             ],
18951             "optional": false,
18952             "field": "lastMsgDirection",
18953             "description": ""
18954           },
18955           {
18956             "group": "Body",
18957             "type": "String",
18958             "optional": true,
18959             "field": "from",
18960             "description": ""
18961           },
18962           {
18963             "group": "Body",
18964             "type": "Boolean",
18965             "optional": true,
18966             "field": "autoreplyExecuted",
18967             "description": ""
18968           }
18969         ]
18970       }
18971     },
18972     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18973     "version": "0.0.0",
18974     "filename": "server/api/openchannelInteraction/index.js",
18975     "groupTitle": "Openchannel_Interactions"
18976   },
18977   {
18978     "type": "delete",
18979     "url": "/api/openchannel/interactions/{id}",
18980     "title": "Deletes a Interaction",
18981     "examples": [
18982       {
18983         "title": "Example usage:",
18984         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18985         "type": "json"
18986       }
18987     ],
18988     "name": "DeleteInteractions",
18989     "group": "Openchannel_Interactions",
18990     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18991     "version": "0.0.0",
18992     "filename": "server/api/openchannelInteraction/index.js",
18993     "groupTitle": "Openchannel_Interactions"
18994   },
18995   {
18996     "type": "get",
18997     "url": "/api/openchannel/interactions/describe",
18998     "title": "Gets table info about Interactions",
18999     "examples": [
19000       {
19001         "title": "Example usage:",
19002         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
19003         "type": "json"
19004       }
19005     ],
19006     "name": "DescribeInteractions",
19007     "group": "Openchannel_Interactions",
19008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19009     "version": "0.0.0",
19010     "filename": "server/api/openchannelInteraction/index.js",
19011     "groupTitle": "Openchannel_Interactions"
19012   },
19013   {
19014     "type": "get",
19015     "url": "/api/openchannel/interactions",
19016     "title": "Gets a list of Interactions",
19017     "examples": [
19018       {
19019         "title": "Example usage:",
19020         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
19021         "type": "json"
19022       }
19023     ],
19024     "name": "GetInteractions",
19025     "group": "Openchannel_Interactions",
19026     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19027     "version": "0.0.0",
19028     "filename": "server/api/openchannelInteraction/index.js",
19029     "groupTitle": "Openchannel_Interactions"
19030   },
19031   {
19032     "type": "delete",
19033     "url": "/api/openchannel/interactions/{id}/tags",
19034     "title": "Removes tags from interaction",
19035     "examples": [
19036       {
19037         "title": "Example usage:",
19038         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19039         "type": "json"
19040       }
19041     ],
19042     "name": "RemoveTags",
19043     "group": "Openchannel_Interactions",
19044     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19045     "version": "0.0.0",
19046     "filename": "server/api/openchannelInteraction/index.js",
19047     "groupTitle": "Openchannel_Interactions"
19048   },
19049   {
19050     "type": "get",
19051     "url": "/api/openchannel/interactions/{id}",
19052     "title": "Gets a single Interaction",
19053     "examples": [
19054       {
19055         "title": "Example usage:",
19056         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
19057         "type": "json"
19058       }
19059     ],
19060     "name": "ShowInteractions",
19061     "group": "Openchannel_Interactions",
19062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19063     "version": "0.0.0",
19064     "filename": "server/api/openchannelInteraction/index.js",
19065     "groupTitle": "Openchannel_Interactions"
19066   },
19067   {
19068     "type": "post",
19069     "url": "/api/openchannel/interactions/{id}/messages",
19070     "title": "Creates new messages",
19071     "examples": [
19072       {
19073         "title": "Example usage:",
19074         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19075         "type": "json"
19076       }
19077     ],
19078     "name": "addMessage",
19079     "group": "Openchannel_Interactions",
19080     "parameter": {
19081       "fields": {
19082         "Body": [
19083           {
19084             "group": "Body",
19085             "type": "Text",
19086             "optional": false,
19087             "field": "body",
19088             "description": ""
19089           },
19090           {
19091             "group": "Body",
19092             "type": "Boolean",
19093             "optional": true,
19094             "field": "read",
19095             "description": ""
19096           },
19097           {
19098             "group": "Body",
19099             "type": "Boolean",
19100             "optional": true,
19101             "field": "secret",
19102             "description": ""
19103           },
19104           {
19105             "group": "Body",
19106             "type": "String",
19107             "allowedValues": [
19108               "\"in\"",
19109               "\"out\""
19110             ],
19111             "optional": false,
19112             "field": "direction",
19113             "description": ""
19114           },
19115           {
19116             "group": "Body",
19117             "type": "String",
19118             "optional": true,
19119             "field": "readAt",
19120             "description": ""
19121           },
19122           {
19123             "group": "Body",
19124             "type": "String",
19125             "optional": true,
19126             "field": "providerName",
19127             "description": ""
19128           },
19129           {
19130             "group": "Body",
19131             "type": "Text",
19132             "optional": true,
19133             "field": "providerResponse",
19134             "description": ""
19135           }
19136         ]
19137       }
19138     },
19139     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19140     "version": "0.0.0",
19141     "filename": "server/api/openchannelInteraction/index.js",
19142     "groupTitle": "Openchannel_Interactions"
19143   },
19144   {
19145     "type": "get",
19146     "url": "/api/openchannel/interactions/{id}/download",
19147     "title": "Gets interaction",
19148     "examples": [
19149       {
19150         "title": "Example usage:",
19151         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
19152         "type": "json"
19153       }
19154     ],
19155     "name": "download",
19156     "group": "Openchannel_Interactions",
19157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19158     "version": "0.0.0",
19159     "filename": "server/api/openchannelInteraction/index.js",
19160     "groupTitle": "Openchannel_Interactions"
19161   },
19162   {
19163     "type": "get",
19164     "url": "/api/openchannel/interactions/{id}/messages",
19165     "title": "Gets interaction messages",
19166     "examples": [
19167       {
19168         "title": "Example usage:",
19169         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
19170         "type": "json"
19171       }
19172     ],
19173     "name": "getMessages",
19174     "group": "Openchannel_Interactions",
19175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19176     "version": "0.0.0",
19177     "filename": "server/api/openchannelInteraction/index.js",
19178     "groupTitle": "Openchannel_Interactions"
19179   },
19180   {
19181     "type": "put",
19182     "url": "/api/openchannel/interactions/{id}",
19183     "title": "Update an existing Interaction",
19184     "examples": [
19185       {
19186         "title": "Example usage:",
19187         "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",
19188         "type": "json"
19189       }
19190     ],
19191     "name": "updateInteractions",
19192     "group": "Openchannel_Interactions",
19193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19194     "version": "0.0.0",
19195     "filename": "server/api/openchannelInteraction/index.js",
19196     "groupTitle": "Openchannel_Interactions"
19197   },
19198   {
19199     "type": "post",
19200     "url": "/api/openchannel/messages",
19201     "title": "Creates a new Message",
19202     "examples": [
19203       {
19204         "title": "Example usage:",
19205         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19206         "type": "json"
19207       }
19208     ],
19209     "name": "CreateMessages",
19210     "group": "Openchannel_Messages",
19211     "parameter": {
19212       "fields": {
19213         "Body": [
19214           {
19215             "group": "Body",
19216             "type": "Text",
19217             "optional": false,
19218             "field": "body",
19219             "description": ""
19220           },
19221           {
19222             "group": "Body",
19223             "type": "Boolean",
19224             "optional": true,
19225             "field": "read",
19226             "description": ""
19227           },
19228           {
19229             "group": "Body",
19230             "type": "Boolean",
19231             "optional": true,
19232             "field": "secret",
19233             "description": ""
19234           },
19235           {
19236             "group": "Body",
19237             "type": "String",
19238             "allowedValues": [
19239               "\"in\"",
19240               "\"out\""
19241             ],
19242             "optional": false,
19243             "field": "direction",
19244             "description": ""
19245           },
19246           {
19247             "group": "Body",
19248             "type": "String",
19249             "optional": true,
19250             "field": "readAt",
19251             "description": ""
19252           },
19253           {
19254             "group": "Body",
19255             "type": "String",
19256             "optional": true,
19257             "field": "providerName",
19258             "description": ""
19259           },
19260           {
19261             "group": "Body",
19262             "type": "Text",
19263             "optional": true,
19264             "field": "providerResponse",
19265             "description": ""
19266           }
19267         ]
19268       }
19269     },
19270     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19271     "version": "0.0.0",
19272     "filename": "server/api/openchannelMessage/index.js",
19273     "groupTitle": "Openchannel_Messages"
19274   },
19275   {
19276     "type": "delete",
19277     "url": "/api/openchannel/messages/{id}",
19278     "title": "Deletes a Message",
19279     "examples": [
19280       {
19281         "title": "Example usage:",
19282         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19283         "type": "json"
19284       }
19285     ],
19286     "name": "DeleteMessages",
19287     "group": "Openchannel_Messages",
19288     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19289     "version": "0.0.0",
19290     "filename": "server/api/openchannelMessage/index.js",
19291     "groupTitle": "Openchannel_Messages"
19292   },
19293   {
19294     "type": "get",
19295     "url": "/api/openchannel/messages/describe",
19296     "title": "Gets table info about Messages",
19297     "examples": [
19298       {
19299         "title": "Example usage:",
19300         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19301         "type": "json"
19302       }
19303     ],
19304     "name": "DescribeMessages",
19305     "group": "Openchannel_Messages",
19306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19307     "version": "0.0.0",
19308     "filename": "server/api/openchannelMessage/index.js",
19309     "groupTitle": "Openchannel_Messages"
19310   },
19311   {
19312     "type": "get",
19313     "url": "/api/openchannel/messages",
19314     "title": "Gets a list of Messages",
19315     "examples": [
19316       {
19317         "title": "Example usage:",
19318         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19319         "type": "json"
19320       }
19321     ],
19322     "name": "GetMessages",
19323     "group": "Openchannel_Messages",
19324     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19325     "version": "0.0.0",
19326     "filename": "server/api/openchannelMessage/index.js",
19327     "groupTitle": "Openchannel_Messages"
19328   },
19329   {
19330     "type": "get",
19331     "url": "/api/openchannel/messages/{id}",
19332     "title": "Gets a single Message",
19333     "examples": [
19334       {
19335         "title": "Example usage:",
19336         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19337         "type": "json"
19338       }
19339     ],
19340     "name": "ShowMessages",
19341     "group": "Openchannel_Messages",
19342     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19343     "version": "0.0.0",
19344     "filename": "server/api/openchannelMessage/index.js",
19345     "groupTitle": "Openchannel_Messages"
19346   },
19347   {
19348     "type": "put",
19349     "url": "/api/openchannel/messages/{id}/accept",
19350     "title": "Accepts message",
19351     "examples": [
19352       {
19353         "title": "Example usage:",
19354         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19355         "type": "json"
19356       }
19357     ],
19358     "name": "acceptMessage",
19359     "group": "Openchannel_Messages",
19360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19361     "version": "0.0.0",
19362     "filename": "server/api/openchannelMessage/index.js",
19363     "groupTitle": "Openchannel_Messages"
19364   },
19365   {
19366     "type": "put",
19367     "url": "/api/openchannel/messages/{id}/reject",
19368     "title": "Rejects message",
19369     "examples": [
19370       {
19371         "title": "Example usage:",
19372         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19373         "type": "json"
19374       }
19375     ],
19376     "name": "rejectMessage",
19377     "group": "Openchannel_Messages",
19378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19379     "version": "0.0.0",
19380     "filename": "server/api/openchannelMessage/index.js",
19381     "groupTitle": "Openchannel_Messages"
19382   },
19383   {
19384     "type": "put",
19385     "url": "/api/openchannel/messages/{id}",
19386     "title": "Update an existing Message",
19387     "examples": [
19388       {
19389         "title": "Example usage:",
19390         "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",
19391         "type": "json"
19392       }
19393     ],
19394     "name": "updateMessages",
19395     "group": "Openchannel_Messages",
19396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19397     "version": "0.0.0",
19398     "filename": "server/api/openchannelMessage/index.js",
19399     "groupTitle": "Openchannel_Messages"
19400   },
19401   {
19402     "type": "post",
19403     "url": "/api/openchannel/reports/queue",
19404     "title": "Creates a new Openchannel Queue Report",
19405     "examples": [
19406       {
19407         "title": "Example usage:",
19408         "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",
19409         "type": "json"
19410       }
19411     ],
19412     "name": "CreateOpenchannel_Queue_Reports",
19413     "group": "Openchannel_Queue_Reports",
19414     "parameter": {
19415       "fields": {
19416         "Body": [
19417           {
19418             "group": "Body",
19419             "type": "String",
19420             "optional": false,
19421             "field": "uniqueid",
19422             "description": ""
19423           },
19424           {
19425             "group": "Body",
19426             "type": "String",
19427             "optional": true,
19428             "field": "from",
19429             "description": ""
19430           },
19431           {
19432             "group": "Body",
19433             "type": "String",
19434             "optional": true,
19435             "field": "joinAt",
19436             "description": ""
19437           },
19438           {
19439             "group": "Body",
19440             "type": "String",
19441             "optional": true,
19442             "field": "leaveAt",
19443             "description": ""
19444           },
19445           {
19446             "group": "Body",
19447             "type": "String",
19448             "optional": true,
19449             "field": "acceptAt",
19450             "description": ""
19451           },
19452           {
19453             "group": "Body",
19454             "type": "String",
19455             "optional": true,
19456             "field": "exitAt",
19457             "description": ""
19458           },
19459           {
19460             "group": "Body",
19461             "type": "String",
19462             "optional": true,
19463             "field": "reason",
19464             "description": ""
19465           }
19466         ]
19467       }
19468     },
19469     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19470     "version": "0.0.0",
19471     "filename": "server/api/openchannelQueueReport/index.js",
19472     "groupTitle": "Openchannel_Queue_Reports"
19473   },
19474   {
19475     "type": "delete",
19476     "url": "/api/openchannel/reports/queue/{id}",
19477     "title": "Deletes a Openchannel Queue Report",
19478     "examples": [
19479       {
19480         "title": "Example usage:",
19481         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19482         "type": "json"
19483       }
19484     ],
19485     "name": "DeleteOpenchannel_Queue_Reports",
19486     "group": "Openchannel_Queue_Reports",
19487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19488     "version": "0.0.0",
19489     "filename": "server/api/openchannelQueueReport/index.js",
19490     "groupTitle": "Openchannel_Queue_Reports"
19491   },
19492   {
19493     "type": "get",
19494     "url": "/api/openchannel/reports/queue/describe",
19495     "title": "Gets table info about Openchannel Queue Reports",
19496     "examples": [
19497       {
19498         "title": "Example usage:",
19499         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19500         "type": "json"
19501       }
19502     ],
19503     "name": "DescribeOpenchannel_Queue_Reports",
19504     "group": "Openchannel_Queue_Reports",
19505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19506     "version": "0.0.0",
19507     "filename": "server/api/openchannelQueueReport/index.js",
19508     "groupTitle": "Openchannel_Queue_Reports"
19509   },
19510   {
19511     "type": "get",
19512     "url": "/api/openchannel/reports/queue",
19513     "title": "Gets a list of Openchannel Queue Reports",
19514     "examples": [
19515       {
19516         "title": "Example usage:",
19517         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19518         "type": "json"
19519       }
19520     ],
19521     "name": "GetOpenchannel_Queue_Reports",
19522     "group": "Openchannel_Queue_Reports",
19523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19524     "version": "0.0.0",
19525     "filename": "server/api/openchannelQueueReport/index.js",
19526     "groupTitle": "Openchannel_Queue_Reports"
19527   },
19528   {
19529     "type": "get",
19530     "url": "/api/openchannel/reports/queue/{id}",
19531     "title": "Gets a single Openchannel Queue Report",
19532     "examples": [
19533       {
19534         "title": "Example usage:",
19535         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19536         "type": "json"
19537       }
19538     ],
19539     "name": "ShowOpenchannel_Queue_Reports",
19540     "group": "Openchannel_Queue_Reports",
19541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19542     "version": "0.0.0",
19543     "filename": "server/api/openchannelQueueReport/index.js",
19544     "groupTitle": "Openchannel_Queue_Reports"
19545   },
19546   {
19547     "type": "put",
19548     "url": "/api/openchannel/reports/queue/{id}",
19549     "title": "Update an existing Openchannel Queue Report",
19550     "examples": [
19551       {
19552         "title": "Example usage:",
19553         "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",
19554         "type": "json"
19555       }
19556     ],
19557     "name": "updateOpenchannel_Queue_Reports",
19558     "group": "Openchannel_Queue_Reports",
19559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19560     "version": "0.0.0",
19561     "filename": "server/api/openchannelQueueReport/index.js",
19562     "groupTitle": "Openchannel_Queue_Reports"
19563   },
19564   {
19565     "type": "post",
19566     "url": "/api/openchannel/queues/{id}/users",
19567     "title": "Add agents to a queue",
19568     "examples": [
19569       {
19570         "title": "Example usage:",
19571         "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",
19572         "type": "json"
19573       }
19574     ],
19575     "name": "AddAgents",
19576     "group": "Openchannel_Queues",
19577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19578     "version": "0.0.0",
19579     "filename": "server/api/openchannelQueue/index.js",
19580     "groupTitle": "Openchannel_Queues"
19581   },
19582   {
19583     "type": "post",
19584     "url": "/api/openchannel/queues/{id}/teams",
19585     "title": "Add teams to a queue",
19586     "examples": [
19587       {
19588         "title": "Example usage:",
19589         "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",
19590         "type": "json"
19591       }
19592     ],
19593     "name": "AddTeams",
19594     "group": "Openchannel_Queues",
19595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19596     "version": "0.0.0",
19597     "filename": "server/api/openchannelQueue/index.js",
19598     "groupTitle": "Openchannel_Queues"
19599   },
19600   {
19601     "type": "post",
19602     "url": "/api/openchannel/queues",
19603     "title": "Creates a new Queue",
19604     "examples": [
19605       {
19606         "title": "Example usage:",
19607         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19608         "type": "json"
19609       }
19610     ],
19611     "name": "CreateQueues",
19612     "group": "Openchannel_Queues",
19613     "parameter": {
19614       "fields": {
19615         "Body": [
19616           {
19617             "group": "Body",
19618             "type": "String",
19619             "optional": true,
19620             "field": "name",
19621             "description": ""
19622           },
19623           {
19624             "group": "Body",
19625             "type": "String",
19626             "optional": true,
19627             "field": "description",
19628             "description": ""
19629           },
19630           {
19631             "group": "Body",
19632             "type": "Integer",
19633             "optional": true,
19634             "field": "timeout",
19635             "description": ""
19636           },
19637           {
19638             "group": "Body",
19639             "type": "String",
19640             "allowedValues": [
19641               "\"rrmemory\"",
19642               "\"beepall\"",
19643               "\"roundrobin\""
19644             ],
19645             "optional": true,
19646             "field": "strategy",
19647             "description": ""
19648           }
19649         ]
19650       }
19651     },
19652     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19653     "version": "0.0.0",
19654     "filename": "server/api/openchannelQueue/index.js",
19655     "groupTitle": "Openchannel_Queues"
19656   },
19657   {
19658     "type": "delete",
19659     "url": "/api/openchannel/queues/{id}",
19660     "title": "Deletes a Queue",
19661     "examples": [
19662       {
19663         "title": "Example usage:",
19664         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19665         "type": "json"
19666       }
19667     ],
19668     "name": "DeleteQueues",
19669     "group": "Openchannel_Queues",
19670     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19671     "version": "0.0.0",
19672     "filename": "server/api/openchannelQueue/index.js",
19673     "groupTitle": "Openchannel_Queues"
19674   },
19675   {
19676     "type": "get",
19677     "url": "/api/openchannel/queues/describe",
19678     "title": "Gets table info about Queues",
19679     "examples": [
19680       {
19681         "title": "Example usage:",
19682         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19683         "type": "json"
19684       }
19685     ],
19686     "name": "DescribeQueues",
19687     "group": "Openchannel_Queues",
19688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19689     "version": "0.0.0",
19690     "filename": "server/api/openchannelQueue/index.js",
19691     "groupTitle": "Openchannel_Queues"
19692   },
19693   {
19694     "type": "get",
19695     "url": "/api/openchannel/queues/{id}/users",
19696     "title": "Gets queue agents",
19697     "examples": [
19698       {
19699         "title": "Example usage:",
19700         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19701         "type": "json"
19702       }
19703     ],
19704     "name": "GetAgents",
19705     "group": "Openchannel_Queues",
19706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19707     "version": "0.0.0",
19708     "filename": "server/api/openchannelQueue/index.js",
19709     "groupTitle": "Openchannel_Queues"
19710   },
19711   {
19712     "type": "get",
19713     "url": "/api/openchannel/queues/{id}/members",
19714     "title": "GetMembers",
19715     "examples": [
19716       {
19717         "title": "Example usage:",
19718         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19719         "type": "json"
19720       }
19721     ],
19722     "name": "GetMembers",
19723     "group": "Openchannel_Queues",
19724     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19725     "version": "0.0.0",
19726     "filename": "server/api/openchannelQueue/index.js",
19727     "groupTitle": "Openchannel_Queues"
19728   },
19729   {
19730     "type": "get",
19731     "url": "/api/openchannel/queues",
19732     "title": "Gets a list of Queues",
19733     "examples": [
19734       {
19735         "title": "Example usage:",
19736         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19737         "type": "json"
19738       }
19739     ],
19740     "name": "GetQueues",
19741     "group": "Openchannel_Queues",
19742     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19743     "version": "0.0.0",
19744     "filename": "server/api/openchannelQueue/index.js",
19745     "groupTitle": "Openchannel_Queues"
19746   },
19747   {
19748     "type": "get",
19749     "url": "/api/openchannel/queues/{id}/teams",
19750     "title": "Gets queues list",
19751     "examples": [
19752       {
19753         "title": "Example usage:",
19754         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19755         "type": "json"
19756       }
19757     ],
19758     "name": "GetTeams",
19759     "group": "Openchannel_Queues",
19760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19761     "version": "0.0.0",
19762     "filename": "server/api/openchannelQueue/index.js",
19763     "groupTitle": "Openchannel_Queues"
19764   },
19765   {
19766     "type": "delete",
19767     "url": "/api/openchannel/queues/{id}/users",
19768     "title": "Removes agents from a queue",
19769     "examples": [
19770       {
19771         "title": "Example usage:",
19772         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19773         "type": "json"
19774       }
19775     ],
19776     "name": "RemoveAgents",
19777     "group": "Openchannel_Queues",
19778     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19779     "version": "0.0.0",
19780     "filename": "server/api/openchannelQueue/index.js",
19781     "groupTitle": "Openchannel_Queues"
19782   },
19783   {
19784     "type": "get",
19785     "url": "/api/openchannel/queues/{id}",
19786     "title": "Gets a single Queue",
19787     "examples": [
19788       {
19789         "title": "Example usage:",
19790         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19791         "type": "json"
19792       }
19793     ],
19794     "name": "ShowQueues",
19795     "group": "Openchannel_Queues",
19796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19797     "version": "0.0.0",
19798     "filename": "server/api/openchannelQueue/index.js",
19799     "groupTitle": "Openchannel_Queues"
19800   },
19801   {
19802     "type": "put",
19803     "url": "/api/openchannel/queues/{id}",
19804     "title": "Update an existing Queue",
19805     "examples": [
19806       {
19807         "title": "Example usage:",
19808         "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",
19809         "type": "json"
19810       }
19811     ],
19812     "name": "updateQueues",
19813     "group": "Openchannel_Queues",
19814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19815     "version": "0.0.0",
19816     "filename": "server/api/openchannelQueue/index.js",
19817     "groupTitle": "Openchannel_Queues"
19818   },
19819   {
19820     "type": "post",
19821     "url": "/api/openchannel/reports/transfer",
19822     "title": "Creates a new Openchannel Transfer Report",
19823     "examples": [
19824       {
19825         "title": "Example usage:",
19826         "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",
19827         "type": "json"
19828       }
19829     ],
19830     "name": "CreateOpenchannel_Transfer_Reports",
19831     "group": "Openchannel_Transfer_Reports",
19832     "parameter": {
19833       "fields": {
19834         "Body": [
19835           {
19836             "group": "Body",
19837             "type": "String",
19838             "optional": false,
19839             "field": "uniqueid",
19840             "description": ""
19841           },
19842           {
19843             "group": "Body",
19844             "type": "String",
19845             "allowedValues": [
19846               "\"account\"",
19847               "\"agent\"",
19848               "\"queue\""
19849             ],
19850             "optional": false,
19851             "field": "type",
19852             "description": ""
19853           },
19854           {
19855             "group": "Body",
19856             "type": "String",
19857             "optional": false,
19858             "field": "transferredAt",
19859             "description": ""
19860           }
19861         ]
19862       }
19863     },
19864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19865     "version": "0.0.0",
19866     "filename": "server/api/openchannelTransferReport/index.js",
19867     "groupTitle": "Openchannel_Transfer_Reports"
19868   },
19869   {
19870     "type": "delete",
19871     "url": "/api/openchannel/reports/transfer/{id}",
19872     "title": "Deletes a Openchannel Transfer Report",
19873     "examples": [
19874       {
19875         "title": "Example usage:",
19876         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19877         "type": "json"
19878       }
19879     ],
19880     "name": "DeleteOpenchannel_Transfer_Reports",
19881     "group": "Openchannel_Transfer_Reports",
19882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19883     "version": "0.0.0",
19884     "filename": "server/api/openchannelTransferReport/index.js",
19885     "groupTitle": "Openchannel_Transfer_Reports"
19886   },
19887   {
19888     "type": "get",
19889     "url": "/api/openchannel/reports/transfer/describe",
19890     "title": "Gets table info about Openchannel Transfer Reports",
19891     "examples": [
19892       {
19893         "title": "Example usage:",
19894         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19895         "type": "json"
19896       }
19897     ],
19898     "name": "DescribeOpenchannel_Transfer_Reports",
19899     "group": "Openchannel_Transfer_Reports",
19900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19901     "version": "0.0.0",
19902     "filename": "server/api/openchannelTransferReport/index.js",
19903     "groupTitle": "Openchannel_Transfer_Reports"
19904   },
19905   {
19906     "type": "get",
19907     "url": "/api/openchannel/reports/transfer",
19908     "title": "Gets a list of Openchannel Transfer Reports",
19909     "examples": [
19910       {
19911         "title": "Example usage:",
19912         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19913         "type": "json"
19914       }
19915     ],
19916     "name": "GetOpenchannel_Transfer_Reports",
19917     "group": "Openchannel_Transfer_Reports",
19918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19919     "version": "0.0.0",
19920     "filename": "server/api/openchannelTransferReport/index.js",
19921     "groupTitle": "Openchannel_Transfer_Reports"
19922   },
19923   {
19924     "type": "get",
19925     "url": "/api/openchannel/reports/transfer/{id}",
19926     "title": "Gets a single Openchannel Transfer Report",
19927     "examples": [
19928       {
19929         "title": "Example usage:",
19930         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19931         "type": "json"
19932       }
19933     ],
19934     "name": "ShowOpenchannel_Transfer_Reports",
19935     "group": "Openchannel_Transfer_Reports",
19936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19937     "version": "0.0.0",
19938     "filename": "server/api/openchannelTransferReport/index.js",
19939     "groupTitle": "Openchannel_Transfer_Reports"
19940   },
19941   {
19942     "type": "put",
19943     "url": "/api/openchannel/reports/transfer/{id}",
19944     "title": "Update an existing Openchannel Transfer Report",
19945     "examples": [
19946       {
19947         "title": "Example usage:",
19948         "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",
19949         "type": "json"
19950       }
19951     ],
19952     "name": "updateOpenchannel_Transfer_Reports",
19953     "group": "Openchannel_Transfer_Reports",
19954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19955     "version": "0.0.0",
19956     "filename": "server/api/openchannelTransferReport/index.js",
19957     "groupTitle": "Openchannel_Transfer_Reports"
19958   },
19959   {
19960     "type": "post",
19961     "url": "/api/pauses",
19962     "title": "Creates a new Pause",
19963     "examples": [
19964       {
19965         "title": "Example usage:",
19966         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19967         "type": "json"
19968       }
19969     ],
19970     "name": "CreatePauses",
19971     "group": "Pauses",
19972     "parameter": {
19973       "fields": {
19974         "Body": [
19975           {
19976             "group": "Body",
19977             "type": "String",
19978             "optional": false,
19979             "field": "name",
19980             "description": ""
19981           },
19982           {
19983             "group": "Body",
19984             "type": "String",
19985             "optional": true,
19986             "field": "description",
19987             "description": ""
19988           }
19989         ]
19990       }
19991     },
19992     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19993     "version": "0.0.0",
19994     "filename": "server/api/pause/index.js",
19995     "groupTitle": "Pauses"
19996   },
19997   {
19998     "type": "delete",
19999     "url": "/api/pauses/{id}",
20000     "title": "Deletes a Pause",
20001     "examples": [
20002       {
20003         "title": "Example usage:",
20004         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
20005         "type": "json"
20006       }
20007     ],
20008     "name": "DeletePauses",
20009     "group": "Pauses",
20010     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20011     "version": "0.0.0",
20012     "filename": "server/api/pause/index.js",
20013     "groupTitle": "Pauses"
20014   },
20015   {
20016     "type": "get",
20017     "url": "/api/pauses",
20018     "title": "Gets a list of Pauses",
20019     "examples": [
20020       {
20021         "title": "Example usage:",
20022         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
20023         "type": "json"
20024       }
20025     ],
20026     "name": "GetPauses",
20027     "group": "Pauses",
20028     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20029     "version": "0.0.0",
20030     "filename": "server/api/pause/index.js",
20031     "groupTitle": "Pauses"
20032   },
20033   {
20034     "type": "get",
20035     "url": "/api/pauses/{id}",
20036     "title": "Gets a single Pause",
20037     "examples": [
20038       {
20039         "title": "Example usage:",
20040         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
20041         "type": "json"
20042       }
20043     ],
20044     "name": "ShowPauses",
20045     "group": "Pauses",
20046     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20047     "version": "0.0.0",
20048     "filename": "server/api/pause/index.js",
20049     "groupTitle": "Pauses"
20050   },
20051   {
20052     "type": "put",
20053     "url": "/api/pauses/{id}",
20054     "title": "Update an existing Pause",
20055     "examples": [
20056       {
20057         "title": "Example usage:",
20058         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20059         "type": "json"
20060       }
20061     ],
20062     "name": "updatePauses",
20063     "group": "Pauses",
20064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20065     "version": "0.0.0",
20066     "filename": "server/api/pause/index.js",
20067     "groupTitle": "Pauses"
20068   },
20069   {
20070     "type": "get",
20071     "url": "/api/plugins",
20072     "title": "Gets a list of Plugins",
20073     "examples": [
20074       {
20075         "title": "Example usage:",
20076         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
20077         "type": "json"
20078       }
20079     ],
20080     "name": "GetPlugins",
20081     "group": "Plugins",
20082     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20083     "version": "0.0.0",
20084     "filename": "server/api/plugin/index.js",
20085     "groupTitle": "Plugins"
20086   },
20087   {
20088     "type": "get",
20089     "url": "/api/plugins/{id}",
20090     "title": "Gets a single Plugin",
20091     "examples": [
20092       {
20093         "title": "Example usage:",
20094         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
20095         "type": "json"
20096       }
20097     ],
20098     "name": "ShowPlugins",
20099     "group": "Plugins",
20100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20101     "version": "0.0.0",
20102     "filename": "server/api/plugin/index.js",
20103     "groupTitle": "Plugins"
20104   },
20105   {
20106     "type": "delete",
20107     "url": "/api/plugins/{id}",
20108     "title": "Delete a plugin",
20109     "examples": [
20110       {
20111         "title": "Example usage:",
20112         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
20113         "type": "json"
20114       }
20115     ],
20116     "name": "destroyPlugin",
20117     "group": "Plugins",
20118     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20119     "version": "0.0.0",
20120     "filename": "server/api/plugin/index.js",
20121     "groupTitle": "Plugins"
20122   },
20123   {
20124     "type": "get",
20125     "url": "/api/plugins/{id}/download",
20126     "title": "Download plugin source code",
20127     "examples": [
20128       {
20129         "title": "Example usage:",
20130         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
20131         "type": "json"
20132       }
20133     ],
20134     "name": "download",
20135     "group": "Plugins",
20136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20137     "version": "0.0.0",
20138     "filename": "server/api/plugin/index.js",
20139     "groupTitle": "Plugins"
20140   },
20141   {
20142     "type": "put",
20143     "url": "/api/plugins/{id}",
20144     "title": "Update an existing plugin",
20145     "examples": [
20146       {
20147         "title": "Example usage:",
20148         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
20149         "type": "json"
20150       }
20151     ],
20152     "name": "updatePlugin",
20153     "group": "Plugins",
20154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20155     "version": "0.0.0",
20156     "filename": "server/api/plugin/index.js",
20157     "groupTitle": "Plugins"
20158   },
20159   {
20160     "type": "post",
20161     "url": "/api/plugins",
20162     "title": "Upload new plugin",
20163     "examples": [
20164       {
20165         "title": "Example usage:",
20166         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
20167         "type": "json"
20168       }
20169     ],
20170     "name": "uploadPlugin",
20171     "group": "Plugins",
20172     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20173     "version": "0.0.0",
20174     "filename": "server/api/plugin/index.js",
20175     "groupTitle": "Plugins"
20176   },
20177   {
20178     "type": "get",
20179     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20180     "title": "Redirect a plugin request to the specified path",
20181     "examples": [
20182       {
20183         "title": "Example usage:",
20184         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
20185         "type": "json"
20186       }
20187     ],
20188     "name": "webhookPlugin",
20189     "group": "Plugins",
20190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20191     "version": "0.0.0",
20192     "filename": "server/api/plugin/index.js",
20193     "groupTitle": "Plugins"
20194   },
20195   {
20196     "type": "post",
20197     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20198     "title": "Redirect a plugin request to the specified path",
20199     "examples": [
20200       {
20201         "title": "Example usage:",
20202         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
20203         "type": "json"
20204       }
20205     ],
20206     "name": "webhookPlugin",
20207     "group": "Plugins",
20208     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20209     "version": "0.0.0",
20210     "filename": "server/api/plugin/index.js",
20211     "groupTitle": "Plugins"
20212   },
20213   {
20214     "type": "delete",
20215     "url": "/api/pm2/{id}",
20216     "title": "Deletes an existing process",
20217     "examples": [
20218       {
20219         "title": "Example usage:",
20220         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
20221         "type": "json"
20222       }
20223     ],
20224     "name": "DeletePm2Process",
20225     "group": "Pm2",
20226     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20227     "version": "0.0.0",
20228     "filename": "server/api/pm2/index.js",
20229     "groupTitle": "Pm2"
20230   },
20231   {
20232     "type": "get",
20233     "url": "/api/pm2/{id}",
20234     "title": "Gets a single pm2 process",
20235     "examples": [
20236       {
20237         "title": "Example usage:",
20238         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
20239         "type": "json"
20240       }
20241     ],
20242     "name": "GetPm2Process",
20243     "group": "Pm2",
20244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20245     "version": "0.0.0",
20246     "filename": "server/api/pm2/index.js",
20247     "groupTitle": "Pm2"
20248   },
20249   {
20250     "type": "get",
20251     "url": "/api/pm2",
20252     "title": "Gets pm2 processes",
20253     "examples": [
20254       {
20255         "title": "Example usage:",
20256         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
20257         "type": "json"
20258       }
20259     ],
20260     "name": "GetPm2Processes",
20261     "group": "Pm2",
20262     "description": "<p>Motion returns the pm2 processes list.</p>",
20263     "version": "0.0.0",
20264     "filename": "server/api/pm2/index.js",
20265     "groupTitle": "Pm2"
20266   },
20267   {
20268     "type": "post",
20269     "url": "/api/pm2",
20270     "title": "Start a single pm2 process",
20271     "examples": [
20272       {
20273         "title": "Example usage:",
20274         "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",
20275         "type": "json"
20276       }
20277     ],
20278     "name": "StartPm2Process",
20279     "group": "Pm2",
20280     "parameter": {
20281       "fields": {
20282         "Body": [
20283           {
20284             "group": "Body",
20285             "type": "String",
20286             "optional": false,
20287             "field": "name",
20288             "description": ""
20289           },
20290           {
20291             "group": "Body",
20292             "type": "String",
20293             "optional": false,
20294             "field": "script",
20295             "description": ""
20296           }
20297         ]
20298       }
20299     },
20300     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20301     "version": "0.0.0",
20302     "filename": "server/api/pm2/index.js",
20303     "groupTitle": "Pm2"
20304   },
20305   {
20306     "type": "put",
20307     "url": "/api/pm2/{id}",
20308     "title": "Update an existing process",
20309     "examples": [
20310       {
20311         "title": "Example usage:",
20312         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20313         "type": "json"
20314       }
20315     ],
20316     "name": "UpdatePm2Process",
20317     "group": "Pm2",
20318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20319     "version": "0.0.0",
20320     "filename": "server/api/pm2/index.js",
20321     "groupTitle": "Pm2"
20322   },
20323   {
20324     "type": "get",
20325     "url": "/api/rpc/campaigns/",
20326     "title": "Gets a list of campaigns",
20327     "examples": [
20328       {
20329         "title": "Example usage:",
20330         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20331         "type": "json"
20332       }
20333     ],
20334     "name": "Campaigns",
20335     "group": "RPC_Realtime",
20336     "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>",
20337     "version": "0.0.0",
20338     "filename": "server/api/rpc/index.js",
20339     "groupTitle": "RPC_Realtime"
20340   },
20341   {
20342     "type": "get",
20343     "url": "/api/rpc/fax/accounts",
20344     "title": "Gets a list of FaxAccounts",
20345     "examples": [
20346       {
20347         "title": "Example usage:",
20348         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20349         "type": "json"
20350       }
20351     ],
20352     "name": "FaxAccounts",
20353     "group": "RPC_Realtime",
20354     "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>",
20355     "version": "0.0.0",
20356     "filename": "server/api/rpc/index.js",
20357     "groupTitle": "RPC_Realtime"
20358   },
20359   {
20360     "type": "put",
20361     "url": "/api/rpc/agents/:id/capacity",
20362     "title": "Sets agent capacity",
20363     "examples": [
20364       {
20365         "title": "Example usage:",
20366         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20367         "type": "json"
20368       }
20369     ],
20370     "name": "RTAgentCapacity",
20371     "group": "RPC_Realtime",
20372     "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>",
20373     "version": "0.0.0",
20374     "filename": "server/api/rpc/index.js",
20375     "groupTitle": "RPC_Realtime"
20376   },
20377   {
20378     "type": "get",
20379     "url": "/api/rpc/agents",
20380     "title": "Gets a list of RTAgents",
20381     "examples": [
20382       {
20383         "title": "Example usage:",
20384         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20385         "type": "json"
20386       }
20387     ],
20388     "name": "RTAgents",
20389     "group": "RPC_Realtime",
20390     "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>",
20391     "version": "0.0.0",
20392     "filename": "server/api/rpc/index.js",
20393     "groupTitle": "RPC_Realtime"
20394   },
20395   {
20396     "type": "get",
20397     "url": "/api/rpc/chat/queues",
20398     "title": "Gets a list of RTChatQueues",
20399     "examples": [
20400       {
20401         "title": "Example usage:",
20402         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20403         "type": "json"
20404       }
20405     ],
20406     "name": "RTChatQueues",
20407     "group": "RPC_Realtime",
20408     "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>",
20409     "version": "0.0.0",
20410     "filename": "server/api/rpc/index.js",
20411     "groupTitle": "RPC_Realtime"
20412   },
20413   {
20414     "type": "get",
20415     "url": "/api/rpc/fax/queues",
20416     "title": "Gets a list of RTFaxQueues",
20417     "examples": [
20418       {
20419         "title": "Example usage:",
20420         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20421         "type": "json"
20422       }
20423     ],
20424     "name": "RTFaxQueues",
20425     "group": "RPC_Realtime",
20426     "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>",
20427     "version": "0.0.0",
20428     "filename": "server/api/rpc/index.js",
20429     "groupTitle": "RPC_Realtime"
20430   },
20431   {
20432     "type": "get",
20433     "url": "/api/rpc/mail/accounts",
20434     "title": "Gets a list of RTMailAccounts",
20435     "examples": [
20436       {
20437         "title": "Example usage:",
20438         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20439         "type": "json"
20440       }
20441     ],
20442     "name": "RTMailAccounts",
20443     "group": "RPC_Realtime",
20444     "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>",
20445     "version": "0.0.0",
20446     "filename": "server/api/rpc/index.js",
20447     "groupTitle": "RPC_Realtime"
20448   },
20449   {
20450     "type": "get",
20451     "url": "/api/rpc/mail/queues",
20452     "title": "Gets a list of RTMailQueues",
20453     "examples": [
20454       {
20455         "title": "Example usage:",
20456         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20457         "type": "json"
20458       }
20459     ],
20460     "name": "RTMailQueues",
20461     "group": "RPC_Realtime",
20462     "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>",
20463     "version": "0.0.0",
20464     "filename": "server/api/rpc/index.js",
20465     "groupTitle": "RPC_Realtime"
20466   },
20467   {
20468     "type": "get",
20469     "url": "/api/rpc/openchannel/queues",
20470     "title": "Gets a list of RTOpenchannelQueues",
20471     "examples": [
20472       {
20473         "title": "Example usage:",
20474         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20475         "type": "json"
20476       }
20477     ],
20478     "name": "RTOpenchannelQueues",
20479     "group": "RPC_Realtime",
20480     "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>",
20481     "version": "0.0.0",
20482     "filename": "server/api/rpc/index.js",
20483     "groupTitle": "RPC_Realtime"
20484   },
20485   {
20486     "type": "get",
20487     "url": "/api/rpc/outbound/channels",
20488     "title": "Gets a list of RTOutboundChannels",
20489     "examples": [
20490       {
20491         "title": "Example usage:",
20492         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20493         "type": "json"
20494       }
20495     ],
20496     "name": "RTOutboundChannels",
20497     "group": "RPC_Realtime",
20498     "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>",
20499     "version": "0.0.0",
20500     "filename": "server/api/rpc/index.js",
20501     "groupTitle": "RPC_Realtime"
20502   },
20503   {
20504     "type": "get",
20505     "url": "/api/rpc/sms/queues",
20506     "title": "Gets a list of RTSmsQueues",
20507     "examples": [
20508       {
20509         "title": "Example usage:",
20510         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20511         "type": "json"
20512       }
20513     ],
20514     "name": "RTSmsQueues",
20515     "group": "RPC_Realtime",
20516     "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>",
20517     "version": "0.0.0",
20518     "filename": "server/api/rpc/index.js",
20519     "groupTitle": "RPC_Realtime"
20520   },
20521   {
20522     "type": "get",
20523     "url": "/api/rpc/telephones",
20524     "title": "Gets a list of RTTelephones",
20525     "examples": [
20526       {
20527         "title": "Example usage:",
20528         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20529         "type": "json"
20530       }
20531     ],
20532     "name": "RTTelephones",
20533     "group": "RPC_Realtime",
20534     "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>",
20535     "version": "0.0.0",
20536     "filename": "server/api/rpc/index.js",
20537     "groupTitle": "RPC_Realtime"
20538   },
20539   {
20540     "type": "get",
20541     "url": "/api/rpc/trunks",
20542     "title": "Gets a list of RTTrunks",
20543     "examples": [
20544       {
20545         "title": "Example usage:",
20546         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20547         "type": "json"
20548       }
20549     ],
20550     "name": "RTTrunks",
20551     "group": "RPC_Realtime",
20552     "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>",
20553     "version": "0.0.0",
20554     "filename": "server/api/rpc/index.js",
20555     "groupTitle": "RPC_Realtime"
20556   },
20557   {
20558     "type": "get",
20559     "url": "/api/rpc/voice/channels",
20560     "title": "Gets a list of RTVoiceChannelMixMonitor",
20561     "examples": [
20562       {
20563         "title": "Example usage:",
20564         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20565         "type": "json"
20566       }
20567     ],
20568     "name": "RTVoiceChannelMixMonitor",
20569     "group": "RPC_Realtime",
20570     "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>",
20571     "version": "0.0.0",
20572     "filename": "server/api/rpc/index.js",
20573     "groupTitle": "RPC_Realtime"
20574   },
20575   {
20576     "type": "get",
20577     "url": "/api/rpc/voice/channels",
20578     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20579     "examples": [
20580       {
20581         "title": "Example usage:",
20582         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20583         "type": "json"
20584       }
20585     ],
20586     "name": "RTVoiceChannelStopMixMonitor",
20587     "group": "RPC_Realtime",
20588     "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>",
20589     "version": "0.0.0",
20590     "filename": "server/api/rpc/index.js",
20591     "groupTitle": "RPC_Realtime"
20592   },
20593   {
20594     "type": "get",
20595     "url": "/api/rpc/voice/channels",
20596     "title": "Gets a list of RTVoiceChannels",
20597     "examples": [
20598       {
20599         "title": "Example usage:",
20600         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20601         "type": "json"
20602       }
20603     ],
20604     "name": "RTVoiceChannels",
20605     "group": "RPC_Realtime",
20606     "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>",
20607     "version": "0.0.0",
20608     "filename": "server/api/rpc/index.js",
20609     "groupTitle": "RPC_Realtime"
20610   },
20611   {
20612     "type": "get",
20613     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20614     "title": "Gets a single RTVoiceQueueChannel",
20615     "examples": [
20616       {
20617         "title": "Example usage:",
20618         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20619         "type": "json"
20620       }
20621     ],
20622     "name": "RTVoiceQueueChannel",
20623     "group": "RPC_Realtime",
20624     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20625     "version": "0.0.0",
20626     "filename": "server/api/rpc/index.js",
20627     "groupTitle": "RPC_Realtime"
20628   },
20629   {
20630     "type": "get",
20631     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20632     "title": "Hangup a single RTVoiceQueueChannel",
20633     "examples": [
20634       {
20635         "title": "Example usage:",
20636         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20637         "type": "json"
20638       }
20639     ],
20640     "name": "RTVoiceQueueChannelHangup",
20641     "group": "RPC_Realtime",
20642     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20643     "version": "0.0.0",
20644     "filename": "server/api/rpc/index.js",
20645     "groupTitle": "RPC_Realtime"
20646   },
20647   {
20648     "type": "get",
20649     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20650     "title": "Hangup a single RTVoiceQueueChannel",
20651     "examples": [
20652       {
20653         "title": "Example usage:",
20654         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20655         "type": "json"
20656       }
20657     ],
20658     "name": "RTVoiceQueueChannelRedirect",
20659     "group": "RPC_Realtime",
20660     "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>",
20661     "version": "0.0.0",
20662     "filename": "server/api/rpc/index.js",
20663     "groupTitle": "RPC_Realtime"
20664   },
20665   {
20666     "type": "get",
20667     "url": "/api/rpc/voice/queues/preview/{id}",
20668     "title": "Gets a single preview contact",
20669     "examples": [
20670       {
20671         "title": "Example usage:",
20672         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20673         "type": "json"
20674       }
20675     ],
20676     "name": "RTVoiceQueuePreview",
20677     "group": "RPC_Realtime",
20678     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20679     "version": "0.0.0",
20680     "filename": "server/api/rpc/index.js",
20681     "groupTitle": "RPC_Realtime"
20682   },
20683   {
20684     "type": "get",
20685     "url": "/api/rpc/voice/queues",
20686     "title": "Gets a list of RTVoiceQueues",
20687     "examples": [
20688       {
20689         "title": "Example usage:",
20690         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20691         "type": "json"
20692       }
20693     ],
20694     "name": "RTVoiceQueues",
20695     "group": "RPC_Realtime",
20696     "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>",
20697     "version": "0.0.0",
20698     "filename": "server/api/rpc/index.js",
20699     "groupTitle": "RPC_Realtime"
20700   },
20701   {
20702     "type": "get",
20703     "url": "/api/rpc/outbound",
20704     "title": "Gets a list of RTOutbound",
20705     "examples": [
20706       {
20707         "title": "Example usage:",
20708         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20709         "type": "json"
20710       }
20711     ],
20712     "name": "RTVoiceQueues",
20713     "group": "RPC_Realtime",
20714     "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>",
20715     "version": "0.0.0",
20716     "filename": "server/api/rpc/index.js",
20717     "groupTitle": "RPC_Realtime"
20718   },
20719   {
20720     "type": "get",
20721     "url": "/api/rpc/voice/queues/channels",
20722     "title": "Gets a list of RTVoiceQueuesChannels",
20723     "examples": [
20724       {
20725         "title": "Example usage:",
20726         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20727         "type": "json"
20728       }
20729     ],
20730     "name": "RTVoiceQueuesChannels",
20731     "group": "RPC_Realtime",
20732     "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>",
20733     "version": "0.0.0",
20734     "filename": "server/api/rpc/index.js",
20735     "groupTitle": "RPC_Realtime"
20736   },
20737   {
20738     "type": "get",
20739     "url": "/api/rpc/chat/queues/{id}",
20740     "title": "Gets a single RTChatQueue",
20741     "examples": [
20742       {
20743         "title": "Example usage:",
20744         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20745         "type": "json"
20746       }
20747     ],
20748     "name": "ShowRTChatQueues",
20749     "group": "RPC_Realtime",
20750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20751     "version": "0.0.0",
20752     "filename": "server/api/rpc/index.js",
20753     "groupTitle": "RPC_Realtime"
20754   },
20755   {
20756     "type": "get",
20757     "url": "/api/rpc/fax/queues/{id}",
20758     "title": "Gets a single RTFaxQueue",
20759     "examples": [
20760       {
20761         "title": "Example usage:",
20762         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20763         "type": "json"
20764       }
20765     ],
20766     "name": "ShowRTFaxQueues",
20767     "group": "RPC_Realtime",
20768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20769     "version": "0.0.0",
20770     "filename": "server/api/rpc/index.js",
20771     "groupTitle": "RPC_Realtime"
20772   },
20773   {
20774     "type": "get",
20775     "url": "/api/rpc/mail/queues/{id}",
20776     "title": "Gets a single RTMailQueue",
20777     "examples": [
20778       {
20779         "title": "Example usage:",
20780         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20781         "type": "json"
20782       }
20783     ],
20784     "name": "ShowRTMailQueues",
20785     "group": "RPC_Realtime",
20786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20787     "version": "0.0.0",
20788     "filename": "server/api/rpc/index.js",
20789     "groupTitle": "RPC_Realtime"
20790   },
20791   {
20792     "type": "get",
20793     "url": "/api/rpc/openchannel/queues/{id}",
20794     "title": "Gets a single RTOpenchannelQueue",
20795     "examples": [
20796       {
20797         "title": "Example usage:",
20798         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20799         "type": "json"
20800       }
20801     ],
20802     "name": "ShowRTOpenchannelQueues",
20803     "group": "RPC_Realtime",
20804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20805     "version": "0.0.0",
20806     "filename": "server/api/rpc/index.js",
20807     "groupTitle": "RPC_Realtime"
20808   },
20809   {
20810     "type": "get",
20811     "url": "/api/rpc/sms/queues/{id}",
20812     "title": "Gets a single RTSmsQueue",
20813     "examples": [
20814       {
20815         "title": "Example usage:",
20816         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20817         "type": "json"
20818       }
20819     ],
20820     "name": "ShowRTSmsQueues",
20821     "group": "RPC_Realtime",
20822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20823     "version": "0.0.0",
20824     "filename": "server/api/rpc/index.js",
20825     "groupTitle": "RPC_Realtime"
20826   },
20827   {
20828     "type": "get",
20829     "url": "/api/rpc/voice/queues/{id}",
20830     "title": "Gets a single RTVoiceQueue",
20831     "examples": [
20832       {
20833         "title": "Example usage:",
20834         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20835         "type": "json"
20836       }
20837     ],
20838     "name": "ShowRTVoiceQueues",
20839     "group": "RPC_Realtime",
20840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20841     "version": "0.0.0",
20842     "filename": "server/api/rpc/index.js",
20843     "groupTitle": "RPC_Realtime"
20844   },
20845   {
20846     "type": "put",
20847     "url": "/api/rpc/voice/{id}/queues",
20848     "title": "Updates a single VoiceQueue",
20849     "examples": [
20850       {
20851         "title": "Example usage:",
20852         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20853         "type": "json"
20854       }
20855     ],
20856     "name": "UpdateVoiceQueues",
20857     "group": "RPC_Realtime",
20858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20859     "version": "0.0.0",
20860     "filename": "server/api/rpc/index.js",
20861     "groupTitle": "RPC_Realtime"
20862   },
20863   {
20864     "type": "post",
20865     "url": "/api/rpc/agents/:id/notify",
20866     "title": "Notify message to a specific agent",
20867     "examples": [
20868       {
20869         "title": "Example usage:",
20870         "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",
20871         "type": "json"
20872       }
20873     ],
20874     "name": "agentNotify",
20875     "group": "RPC_Realtime",
20876     "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>",
20877     "version": "0.0.0",
20878     "filename": "server/api/rpc/index.js",
20879     "groupTitle": "RPC_Realtime"
20880   },
20881   {
20882     "type": "post",
20883     "url": "/api/rpc/chat/queues/:id/notify",
20884     "title": "Notify message to a specific queue",
20885     "examples": [
20886       {
20887         "title": "Example usage:",
20888         "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",
20889         "type": "json"
20890       }
20891     ],
20892     "name": "chatQueueNotify",
20893     "group": "RPC_Realtime",
20894     "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>",
20895     "version": "0.0.0",
20896     "filename": "server/api/rpc/index.js",
20897     "groupTitle": "RPC_Realtime"
20898   },
20899   {
20900     "type": "get",
20901     "url": "/api/rpc/chat/queues/waitinginteractions",
20902     "title": "Gets a list of chatQueuesWaitingInteractions",
20903     "examples": [
20904       {
20905         "title": "Example usage:",
20906         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20907         "type": "json"
20908       }
20909     ],
20910     "name": "chatQueuesWaitingInteractions",
20911     "group": "RPC_Realtime",
20912     "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>",
20913     "version": "0.0.0",
20914     "filename": "server/api/rpc/index.js",
20915     "groupTitle": "RPC_Realtime"
20916   },
20917   {
20918     "type": "post",
20919     "url": "/api/rpc/fax/queues/:id/notify",
20920     "title": "Notify message to a specific queue",
20921     "examples": [
20922       {
20923         "title": "Example usage:",
20924         "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",
20925         "type": "json"
20926       }
20927     ],
20928     "name": "faxQueueNotify",
20929     "group": "RPC_Realtime",
20930     "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>",
20931     "version": "0.0.0",
20932     "filename": "server/api/rpc/index.js",
20933     "groupTitle": "RPC_Realtime"
20934   },
20935   {
20936     "type": "get",
20937     "url": "/api/rpc/fax/queues/waitinginteractions",
20938     "title": "Gets a list of faxQueuesWaitingInteractions",
20939     "examples": [
20940       {
20941         "title": "Example usage:",
20942         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20943         "type": "json"
20944       }
20945     ],
20946     "name": "faxQueuesWaitingInteractions",
20947     "group": "RPC_Realtime",
20948     "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>",
20949     "version": "0.0.0",
20950     "filename": "server/api/rpc/index.js",
20951     "groupTitle": "RPC_Realtime"
20952   },
20953   {
20954     "type": "post",
20955     "url": "/api/rpc/mail/queues/:id/notify",
20956     "title": "Notify message to a specific queue",
20957     "examples": [
20958       {
20959         "title": "Example usage:",
20960         "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",
20961         "type": "json"
20962       }
20963     ],
20964     "name": "mailQueueNotify",
20965     "group": "RPC_Realtime",
20966     "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>",
20967     "version": "0.0.0",
20968     "filename": "server/api/rpc/index.js",
20969     "groupTitle": "RPC_Realtime"
20970   },
20971   {
20972     "type": "get",
20973     "url": "/api/rpc/mail/queues/waitinginteractions",
20974     "title": "Gets a list of mailQueuesWaitingInteractions",
20975     "examples": [
20976       {
20977         "title": "Example usage:",
20978         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20979         "type": "json"
20980       }
20981     ],
20982     "name": "mailQueuesWaitingInteractions",
20983     "group": "RPC_Realtime",
20984     "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>",
20985     "version": "0.0.0",
20986     "filename": "server/api/rpc/index.js",
20987     "groupTitle": "RPC_Realtime"
20988   },
20989   {
20990     "type": "post",
20991     "url": "/api/rpc/openchannel/queues/:id/notify",
20992     "title": "Notify message to a specific queue",
20993     "examples": [
20994       {
20995         "title": "Example usage:",
20996         "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",
20997         "type": "json"
20998       }
20999     ],
21000     "name": "openchannelQueueNotify",
21001     "group": "RPC_Realtime",
21002     "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>",
21003     "version": "0.0.0",
21004     "filename": "server/api/rpc/index.js",
21005     "groupTitle": "RPC_Realtime"
21006   },
21007   {
21008     "type": "get",
21009     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
21010     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
21011     "examples": [
21012       {
21013         "title": "Example usage:",
21014         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
21015         "type": "json"
21016       }
21017     ],
21018     "name": "openchannelQueuesIdWaitingInteractions",
21019     "group": "RPC_Realtime",
21020     "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>",
21021     "version": "0.0.0",
21022     "filename": "server/api/rpc/index.js",
21023     "groupTitle": "RPC_Realtime"
21024   },
21025   {
21026     "type": "get",
21027     "url": "/api/rpc/openchannel/queues/waitinginteractions",
21028     "title": "Gets a list of openchannelQueuesWaitingInteractions",
21029     "examples": [
21030       {
21031         "title": "Example usage:",
21032         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
21033         "type": "json"
21034       }
21035     ],
21036     "name": "openchannelQueuesWaitingInteractions",
21037     "group": "RPC_Realtime",
21038     "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>",
21039     "version": "0.0.0",
21040     "filename": "server/api/rpc/index.js",
21041     "groupTitle": "RPC_Realtime"
21042   },
21043   {
21044     "type": "post",
21045     "url": "/api/rpc/sms/queues/:id/notify",
21046     "title": "Notify message to a specific queue",
21047     "examples": [
21048       {
21049         "title": "Example usage:",
21050         "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",
21051         "type": "json"
21052       }
21053     ],
21054     "name": "smsQueueNotify",
21055     "group": "RPC_Realtime",
21056     "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>",
21057     "version": "0.0.0",
21058     "filename": "server/api/rpc/index.js",
21059     "groupTitle": "RPC_Realtime"
21060   },
21061   {
21062     "type": "get",
21063     "url": "/api/rpc/sms/queues/waitinginteractions",
21064     "title": "Gets a list of smsQueuesWaitingInteractions",
21065     "examples": [
21066       {
21067         "title": "Example usage:",
21068         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
21069         "type": "json"
21070       }
21071     ],
21072     "name": "smsQueuesWaitingInteractions",
21073     "group": "RPC_Realtime",
21074     "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>",
21075     "version": "0.0.0",
21076     "filename": "server/api/rpc/index.js",
21077     "groupTitle": "RPC_Realtime"
21078   },
21079   {
21080     "type": "get",
21081     "url": "/api/realtime/agents",
21082     "title": "Gets realtime agents info",
21083     "examples": [
21084       {
21085         "title": "Example usage:",
21086         "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password}  -X GET",
21087         "type": "json"
21088       }
21089     ],
21090     "name": "getAgents",
21091     "group": "Realtime",
21092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21093     "version": "0.0.0",
21094     "filename": "server/api/realtime/index.js",
21095     "groupTitle": "Realtime"
21096   },
21097   {
21098     "type": "get",
21099     "url": "/api/realtime/queues",
21100     "title": "Gets realtime queues info",
21101     "examples": [
21102       {
21103         "title": "Example usage:",
21104         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
21105         "type": "json"
21106       }
21107     ],
21108     "name": "getQueues",
21109     "group": "Realtime",
21110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21111     "version": "0.0.0",
21112     "filename": "server/api/realtime/index.js",
21113     "groupTitle": "Realtime"
21114   },
21115   {
21116     "type": "post",
21117     "url": "/api/integrations/salesforce/accounts",
21118     "title": "Creates a new Salesforce Account",
21119     "examples": [
21120       {
21121         "title": "Example usage:",
21122         "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",
21123         "type": "json"
21124       }
21125     ],
21126     "name": "CreateSalesforce_Accounts",
21127     "group": "Salesforce_Accounts",
21128     "parameter": {
21129       "fields": {
21130         "Body": [
21131           {
21132             "group": "Body",
21133             "type": "String",
21134             "optional": true,
21135             "field": "name",
21136             "description": ""
21137           },
21138           {
21139             "group": "Body",
21140             "type": "String",
21141             "optional": true,
21142             "field": "description",
21143             "description": ""
21144           },
21145           {
21146             "group": "Body",
21147             "type": "String",
21148             "optional": true,
21149             "field": "username",
21150             "description": ""
21151           },
21152           {
21153             "group": "Body",
21154             "type": "String",
21155             "optional": true,
21156             "field": "remoteUri",
21157             "description": ""
21158           },
21159           {
21160             "group": "Body",
21161             "type": "String",
21162             "optional": true,
21163             "field": "password",
21164             "description": ""
21165           },
21166           {
21167             "group": "Body",
21168             "type": "String",
21169             "optional": true,
21170             "field": "clientId",
21171             "description": ""
21172           },
21173           {
21174             "group": "Body",
21175             "type": "String",
21176             "optional": true,
21177             "field": "clientSecret",
21178             "description": ""
21179           },
21180           {
21181             "group": "Body",
21182             "type": "String",
21183             "optional": true,
21184             "field": "securityToken",
21185             "description": ""
21186           },
21187           {
21188             "group": "Body",
21189             "type": "String",
21190             "optional": false,
21191             "field": "serverUrl",
21192             "description": ""
21193           },
21194           {
21195             "group": "Body",
21196             "type": "String",
21197             "allowedValues": [
21198               "\"integrationTab\"",
21199               "\"newTab\""
21200             ],
21201             "optional": true,
21202             "field": "type",
21203             "description": ""
21204           }
21205         ]
21206       }
21207     },
21208     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21209     "version": "0.0.0",
21210     "filename": "server/api/intSalesforceAccount/index.js",
21211     "groupTitle": "Salesforce_Accounts"
21212   },
21213   {
21214     "type": "delete",
21215     "url": "/api/integrations/salesforce/accounts/{id}",
21216     "title": "Deletes a Salesforce Account",
21217     "examples": [
21218       {
21219         "title": "Example usage:",
21220         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
21221         "type": "json"
21222       }
21223     ],
21224     "name": "DeleteSalesforce_Accounts",
21225     "group": "Salesforce_Accounts",
21226     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21227     "version": "0.0.0",
21228     "filename": "server/api/intSalesforceAccount/index.js",
21229     "groupTitle": "Salesforce_Accounts"
21230   },
21231   {
21232     "type": "get",
21233     "url": "/api/integrations/salesforce/accounts",
21234     "title": "Gets a list of Salesforce Accounts",
21235     "examples": [
21236       {
21237         "title": "Example usage:",
21238         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
21239         "type": "json"
21240       }
21241     ],
21242     "name": "GetSalesforce_Accounts",
21243     "group": "Salesforce_Accounts",
21244     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21245     "version": "0.0.0",
21246     "filename": "server/api/intSalesforceAccount/index.js",
21247     "groupTitle": "Salesforce_Accounts"
21248   },
21249   {
21250     "type": "get",
21251     "url": "/api/integrations/salesforce/accounts/{id}",
21252     "title": "Gets a single Salesforce Account",
21253     "examples": [
21254       {
21255         "title": "Example usage:",
21256         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
21257         "type": "json"
21258       }
21259     ],
21260     "name": "ShowSalesforce_Accounts",
21261     "group": "Salesforce_Accounts",
21262     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21263     "version": "0.0.0",
21264     "filename": "server/api/intSalesforceAccount/index.js",
21265     "groupTitle": "Salesforce_Accounts"
21266   },
21267   {
21268     "type": "post",
21269     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21270     "title": "Creates new configuration",
21271     "examples": [
21272       {
21273         "title": "Example usage:",
21274         "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",
21275         "type": "json"
21276       }
21277     ],
21278     "name": "addConfiguration",
21279     "group": "Salesforce_Accounts",
21280     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21281     "version": "0.0.0",
21282     "filename": "server/api/intSalesforceAccount/index.js",
21283     "groupTitle": "Salesforce_Accounts"
21284   },
21285   {
21286     "type": "get",
21287     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21288     "title": "Gets account configurations",
21289     "examples": [
21290       {
21291         "title": "Example usage:",
21292         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21293         "type": "json"
21294       }
21295     ],
21296     "name": "getConfigurations",
21297     "group": "Salesforce_Accounts",
21298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21299     "version": "0.0.0",
21300     "filename": "server/api/intSalesforceAccount/index.js",
21301     "groupTitle": "Salesforce_Accounts"
21302   },
21303   {
21304     "type": "get",
21305     "url": "/api/integrations/salesforce/accounts/{id}/fields",
21306     "title": "Gets account fields",
21307     "examples": [
21308       {
21309         "title": "Example usage:",
21310         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21311         "type": "json"
21312       }
21313     ],
21314     "name": "getFields",
21315     "group": "Salesforce_Accounts",
21316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21317     "version": "0.0.0",
21318     "filename": "server/api/intSalesforceAccount/index.js",
21319     "groupTitle": "Salesforce_Accounts"
21320   },
21321   {
21322     "type": "put",
21323     "url": "/api/integrations/salesforce/accounts/{id}",
21324     "title": "Update an existing Salesforce Account",
21325     "examples": [
21326       {
21327         "title": "Example usage:",
21328         "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",
21329         "type": "json"
21330       }
21331     ],
21332     "name": "updateSalesforce_Accounts",
21333     "group": "Salesforce_Accounts",
21334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21335     "version": "0.0.0",
21336     "filename": "server/api/intSalesforceAccount/index.js",
21337     "groupTitle": "Salesforce_Accounts"
21338   },
21339   {
21340     "type": "post",
21341     "url": "/api/integrations/salesforce/configurations",
21342     "title": "Creates a new Salesforce Configuration",
21343     "examples": [
21344       {
21345         "title": "Example usage:",
21346         "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",
21347         "type": "json"
21348       }
21349     ],
21350     "name": "CreateSalesforce_Configurations",
21351     "group": "Salesforce_Configurations",
21352     "parameter": {
21353       "fields": {
21354         "Body": [
21355           {
21356             "group": "Body",
21357             "type": "String",
21358             "optional": true,
21359             "field": "name",
21360             "description": ""
21361           },
21362           {
21363             "group": "Body",
21364             "type": "String",
21365             "optional": true,
21366             "field": "description",
21367             "description": ""
21368           },
21369           {
21370             "group": "Body",
21371             "type": "String",
21372             "allowedValues": [
21373               "\"Task\"",
21374               "\"Case\""
21375             ],
21376             "optional": true,
21377             "field": "ticketType",
21378             "description": ""
21379           },
21380           {
21381             "group": "Body",
21382             "type": "String",
21383             "allowedValues": [
21384               "\"contact_lead\"",
21385               "\"contact\"",
21386               "\"lead\"",
21387               "\"account_contact_lead\"",
21388               "\"account\""
21389             ],
21390             "optional": true,
21391             "field": "moduleSearch",
21392             "description": ""
21393           },
21394           {
21395             "group": "Body",
21396             "type": "String",
21397             "allowedValues": [
21398               "\"nothing\"",
21399               "\"contact\"",
21400               "\"lead\"",
21401               "\"account\""
21402             ],
21403             "optional": true,
21404             "field": "moduleCreate",
21405             "description": ""
21406           },
21407           {
21408             "group": "Body",
21409             "type": "String",
21410             "optional": true,
21411             "field": "leadId",
21412             "description": ""
21413           },
21414           {
21415             "group": "Body",
21416             "type": "String",
21417             "optional": true,
21418             "field": "additionalSearchAccount",
21419             "description": ""
21420           },
21421           {
21422             "group": "Body",
21423             "type": "String",
21424             "optional": true,
21425             "field": "additionalSearchContact",
21426             "description": ""
21427           },
21428           {
21429             "group": "Body",
21430             "type": "String",
21431             "optional": true,
21432             "field": "additionalSearchLead",
21433             "description": ""
21434           }
21435         ]
21436       }
21437     },
21438     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21439     "version": "0.0.0",
21440     "filename": "server/api/intSalesforceConfiguration/index.js",
21441     "groupTitle": "Salesforce_Configurations"
21442   },
21443   {
21444     "type": "delete",
21445     "url": "/api/integrations/salesforce/configurations/{id}",
21446     "title": "Deletes a Salesforce Configuration",
21447     "examples": [
21448       {
21449         "title": "Example usage:",
21450         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21451         "type": "json"
21452       }
21453     ],
21454     "name": "DeleteSalesforce_Configurations",
21455     "group": "Salesforce_Configurations",
21456     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21457     "version": "0.0.0",
21458     "filename": "server/api/intSalesforceConfiguration/index.js",
21459     "groupTitle": "Salesforce_Configurations"
21460   },
21461   {
21462     "type": "get",
21463     "url": "/api/integrations/salesforce/configurations",
21464     "title": "Gets a list of Salesforce Configurations",
21465     "examples": [
21466       {
21467         "title": "Example usage:",
21468         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21469         "type": "json"
21470       }
21471     ],
21472     "name": "GetSalesforce_Configurations",
21473     "group": "Salesforce_Configurations",
21474     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21475     "version": "0.0.0",
21476     "filename": "server/api/intSalesforceConfiguration/index.js",
21477     "groupTitle": "Salesforce_Configurations"
21478   },
21479   {
21480     "type": "get",
21481     "url": "/api/integrations/salesforce/configurations/{id}",
21482     "title": "Gets a single Salesforce Configuration",
21483     "examples": [
21484       {
21485         "title": "Example usage:",
21486         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21487         "type": "json"
21488       }
21489     ],
21490     "name": "ShowSalesforce_Configurations",
21491     "group": "Salesforce_Configurations",
21492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21493     "version": "0.0.0",
21494     "filename": "server/api/intSalesforceConfiguration/index.js",
21495     "groupTitle": "Salesforce_Configurations"
21496   },
21497   {
21498     "type": "get",
21499     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21500     "title": "Gets configurations descriptions",
21501     "examples": [
21502       {
21503         "title": "Example usage:",
21504         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21505         "type": "json"
21506       }
21507     ],
21508     "name": "getDescriptions",
21509     "group": "Salesforce_Configurations",
21510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21511     "version": "0.0.0",
21512     "filename": "server/api/intSalesforceConfiguration/index.js",
21513     "groupTitle": "Salesforce_Configurations"
21514   },
21515   {
21516     "type": "get",
21517     "url": "/api/integrations/salesforce/configurations/{id}/fields",
21518     "title": "Gets configurations fields",
21519     "examples": [
21520       {
21521         "title": "Example usage:",
21522         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21523         "type": "json"
21524       }
21525     ],
21526     "name": "getFields",
21527     "group": "Salesforce_Configurations",
21528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21529     "version": "0.0.0",
21530     "filename": "server/api/intSalesforceConfiguration/index.js",
21531     "groupTitle": "Salesforce_Configurations"
21532   },
21533   {
21534     "type": "get",
21535     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21536     "title": "Gets configurations subjects",
21537     "examples": [
21538       {
21539         "title": "Example usage:",
21540         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21541         "type": "json"
21542       }
21543     ],
21544     "name": "getSubjects",
21545     "group": "Salesforce_Configurations",
21546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21547     "version": "0.0.0",
21548     "filename": "server/api/intSalesforceConfiguration/index.js",
21549     "groupTitle": "Salesforce_Configurations"
21550   },
21551   {
21552     "type": "put",
21553     "url": "/api/integrations/salesforce/configurations/{id}",
21554     "title": "Update an existing Salesforce Configuration",
21555     "examples": [
21556       {
21557         "title": "Example usage:",
21558         "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",
21559         "type": "json"
21560       }
21561     ],
21562     "name": "updateSalesforce_Configurations",
21563     "group": "Salesforce_Configurations",
21564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21565     "version": "0.0.0",
21566     "filename": "server/api/intSalesforceConfiguration/index.js",
21567     "groupTitle": "Salesforce_Configurations"
21568   },
21569   {
21570     "type": "post",
21571     "url": "/api/integrations/salesforce/fields",
21572     "title": "Creates a new Salesforce Field",
21573     "examples": [
21574       {
21575         "title": "Example usage:",
21576         "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",
21577         "type": "json"
21578       }
21579     ],
21580     "name": "CreateSalesforce_Fields",
21581     "group": "Salesforce_Fields",
21582     "parameter": {
21583       "fields": {
21584         "Body": [
21585           {
21586             "group": "Body",
21587             "type": "String",
21588             "allowedValues": [
21589               "\"string\"",
21590               "\"variable\"",
21591               "\"customVariable\"",
21592               "\"keyValue\"",
21593               "\"picklist\""
21594             ],
21595             "optional": true,
21596             "field": "type",
21597             "description": ""
21598           },
21599           {
21600             "group": "Body",
21601             "type": "String",
21602             "optional": true,
21603             "field": "content",
21604             "description": ""
21605           },
21606           {
21607             "group": "Body",
21608             "type": "String",
21609             "optional": true,
21610             "field": "key",
21611             "description": ""
21612           },
21613           {
21614             "group": "Body",
21615             "type": "String",
21616             "allowedValues": [
21617               "\"string\"",
21618               "\"variable\"",
21619               "\"customVariable\""
21620             ],
21621             "optional": true,
21622             "field": "keyType",
21623             "description": ""
21624           },
21625           {
21626             "group": "Body",
21627             "type": "String",
21628             "optional": true,
21629             "field": "keyContent",
21630             "description": ""
21631           },
21632           {
21633             "group": "Body",
21634             "type": "String",
21635             "optional": true,
21636             "field": "idField",
21637             "description": ""
21638           },
21639           {
21640             "group": "Body",
21641             "type": "String",
21642             "optional": true,
21643             "field": "variableName",
21644             "description": ""
21645           }
21646         ]
21647       }
21648     },
21649     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21650     "version": "0.0.0",
21651     "filename": "server/api/intSalesforceField/index.js",
21652     "groupTitle": "Salesforce_Fields"
21653   },
21654   {
21655     "type": "delete",
21656     "url": "/api/integrations/salesforce/fields/{id}",
21657     "title": "Deletes a Salesforce Field",
21658     "examples": [
21659       {
21660         "title": "Example usage:",
21661         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21662         "type": "json"
21663       }
21664     ],
21665     "name": "DeleteSalesforce_Fields",
21666     "group": "Salesforce_Fields",
21667     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21668     "version": "0.0.0",
21669     "filename": "server/api/intSalesforceField/index.js",
21670     "groupTitle": "Salesforce_Fields"
21671   },
21672   {
21673     "type": "get",
21674     "url": "/api/integrations/salesforce/fields",
21675     "title": "Gets a list of Salesforce Fields",
21676     "examples": [
21677       {
21678         "title": "Example usage:",
21679         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21680         "type": "json"
21681       }
21682     ],
21683     "name": "GetSalesforce_Fields",
21684     "group": "Salesforce_Fields",
21685     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21686     "version": "0.0.0",
21687     "filename": "server/api/intSalesforceField/index.js",
21688     "groupTitle": "Salesforce_Fields"
21689   },
21690   {
21691     "type": "get",
21692     "url": "/api/integrations/salesforce/fields/{id}",
21693     "title": "Gets a single Salesforce Field",
21694     "examples": [
21695       {
21696         "title": "Example usage:",
21697         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21698         "type": "json"
21699       }
21700     ],
21701     "name": "ShowSalesforce_Fields",
21702     "group": "Salesforce_Fields",
21703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21704     "version": "0.0.0",
21705     "filename": "server/api/intSalesforceField/index.js",
21706     "groupTitle": "Salesforce_Fields"
21707   },
21708   {
21709     "type": "put",
21710     "url": "/api/integrations/salesforce/fields/{id}",
21711     "title": "Update an existing Salesforce Field",
21712     "examples": [
21713       {
21714         "title": "Example usage:",
21715         "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",
21716         "type": "json"
21717       }
21718     ],
21719     "name": "updateSalesforce_Fields",
21720     "group": "Salesforce_Fields",
21721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21722     "version": "0.0.0",
21723     "filename": "server/api/intSalesforceField/index.js",
21724     "groupTitle": "Salesforce_Fields"
21725   },
21726   {
21727     "type": "post",
21728     "url": "/api/schedules",
21729     "title": "Creates a new Schedule",
21730     "examples": [
21731       {
21732         "title": "Example usage:",
21733         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21734         "type": "json"
21735       }
21736     ],
21737     "name": "CreateSchedules",
21738     "group": "Schedules",
21739     "parameter": {
21740       "fields": {
21741         "Body": [
21742           {
21743             "group": "Body",
21744             "type": "String",
21745             "optional": false,
21746             "field": "name",
21747             "description": ""
21748           },
21749           {
21750             "group": "Body",
21751             "type": "String",
21752             "optional": true,
21753             "field": "description",
21754             "description": ""
21755           },
21756           {
21757             "group": "Body",
21758             "type": "Boolean",
21759             "optional": false,
21760             "field": "active",
21761             "description": ""
21762           },
21763           {
21764             "group": "Body",
21765             "type": "String",
21766             "optional": false,
21767             "field": "cron",
21768             "description": ""
21769           },
21770           {
21771             "group": "Body",
21772             "type": "String",
21773             "optional": false,
21774             "field": "startAt",
21775             "description": ""
21776           },
21777           {
21778             "group": "Body",
21779             "type": "String",
21780             "optional": false,
21781             "field": "endAt",
21782             "description": ""
21783           },
21784           {
21785             "group": "Body",
21786             "type": "Integer",
21787             "optional": false,
21788             "field": "subtractNumber",
21789             "description": ""
21790           },
21791           {
21792             "group": "Body",
21793             "type": "String",
21794             "allowedValues": [
21795               "\"years\"",
21796               "\"quarters\"",
21797               "\"months\"",
21798               "\"weeks\"",
21799               "\"days\"",
21800               "\"hours\"",
21801               "\"minutes\""
21802             ],
21803             "optional": false,
21804             "field": "subtractUnit",
21805             "description": ""
21806           },
21807           {
21808             "group": "Body",
21809             "type": "String",
21810             "allowedValues": [
21811               "\"csv\"",
21812               "\"pdf\"",
21813               "\"xlsx\""
21814             ],
21815             "optional": false,
21816             "field": "output",
21817             "description": ""
21818           },
21819           {
21820             "group": "Body",
21821             "type": "String",
21822             "allowedValues": [
21823               "\"custom\"",
21824               "\"default\""
21825             ],
21826             "optional": false,
21827             "field": "type",
21828             "description": ""
21829           },
21830           {
21831             "group": "Body",
21832             "type": "Boolean",
21833             "optional": true,
21834             "field": "sendMail",
21835             "description": ""
21836           },
21837           {
21838             "group": "Body",
21839             "type": "String",
21840             "optional": true,
21841             "field": "email",
21842             "description": ""
21843           },
21844           {
21845             "group": "Body",
21846             "type": "Text",
21847             "optional": true,
21848             "field": "cc",
21849             "description": ""
21850           },
21851           {
21852             "group": "Body",
21853             "type": "Text",
21854             "optional": true,
21855             "field": "bcc",
21856             "description": ""
21857           },
21858           {
21859             "group": "Body",
21860             "type": "Boolean",
21861             "optional": true,
21862             "field": "sendIfEmpty",
21863             "description": ""
21864           }
21865         ]
21866       }
21867     },
21868     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21869     "version": "0.0.0",
21870     "filename": "server/api/schedule/index.js",
21871     "groupTitle": "Schedules"
21872   },
21873   {
21874     "type": "delete",
21875     "url": "/api/schedules/{id}",
21876     "title": "Deletes a Schedule",
21877     "examples": [
21878       {
21879         "title": "Example usage:",
21880         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21881         "type": "json"
21882       }
21883     ],
21884     "name": "DeleteSchedules",
21885     "group": "Schedules",
21886     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21887     "version": "0.0.0",
21888     "filename": "server/api/schedule/index.js",
21889     "groupTitle": "Schedules"
21890   },
21891   {
21892     "type": "get",
21893     "url": "/api/schedules",
21894     "title": "Gets a list of Schedules",
21895     "examples": [
21896       {
21897         "title": "Example usage:",
21898         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21899         "type": "json"
21900       }
21901     ],
21902     "name": "GetSchedules",
21903     "group": "Schedules",
21904     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21905     "version": "0.0.0",
21906     "filename": "server/api/schedule/index.js",
21907     "groupTitle": "Schedules"
21908   },
21909   {
21910     "type": "get",
21911     "url": "/api/schedules/{id}",
21912     "title": "Gets a single Schedule",
21913     "examples": [
21914       {
21915         "title": "Example usage:",
21916         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21917         "type": "json"
21918       }
21919     ],
21920     "name": "ShowSchedules",
21921     "group": "Schedules",
21922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21923     "version": "0.0.0",
21924     "filename": "server/api/schedule/index.js",
21925     "groupTitle": "Schedules"
21926   },
21927   {
21928     "type": "get",
21929     "url": "/api/schedules/{id}/run",
21930     "title": "Run Scheduler",
21931     "examples": [
21932       {
21933         "title": "Example usage:",
21934         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21935         "type": "json"
21936       }
21937     ],
21938     "name": "run",
21939     "group": "Schedules",
21940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21941     "version": "0.0.0",
21942     "filename": "server/api/schedule/index.js",
21943     "groupTitle": "Schedules"
21944   },
21945   {
21946     "type": "put",
21947     "url": "/api/schedules/{id}",
21948     "title": "Update an existing Schedule",
21949     "examples": [
21950       {
21951         "title": "Example usage:",
21952         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21953         "type": "json"
21954       }
21955     ],
21956     "name": "updateSchedules",
21957     "group": "Schedules",
21958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21959     "version": "0.0.0",
21960     "filename": "server/api/schedule/index.js",
21961     "groupTitle": "Schedules"
21962   },
21963   {
21964     "type": "post",
21965     "url": "/api/screen/recordings",
21966     "title": "Creates a new Recording",
21967     "examples": [
21968       {
21969         "title": "Example usage:",
21970         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21971         "type": "json"
21972       }
21973     ],
21974     "name": "CreateRecordings",
21975     "group": "Screen_Recordings",
21976     "parameter": {
21977       "fields": {
21978         "Body": [
21979           {
21980             "group": "Body",
21981             "type": "Virtual",
21982             "optional": true,
21983             "field": "format",
21984             "description": ""
21985           },
21986           {
21987             "group": "Body",
21988             "type": "String",
21989             "optional": true,
21990             "field": "interactionid",
21991             "description": ""
21992           },
21993           {
21994             "group": "Body",
21995             "type": "String",
21996             "optional": true,
21997             "field": "channel",
21998             "description": ""
21999           },
22000           {
22001             "group": "Body",
22002             "type": "String",
22003             "optional": true,
22004             "field": "value",
22005             "description": ""
22006           },
22007           {
22008             "group": "Body",
22009             "type": "Integer",
22010             "optional": true,
22011             "field": "rating",
22012             "description": ""
22013           },
22014           {
22015             "group": "Body",
22016             "type": "Integer",
22017             "optional": true,
22018             "field": "duration",
22019             "description": ""
22020           },
22021           {
22022             "group": "Body",
22023             "type": "String",
22024             "optional": true,
22025             "field": "startedAt",
22026             "description": ""
22027           },
22028           {
22029             "group": "Body",
22030             "type": "String",
22031             "optional": true,
22032             "field": "closedAt",
22033             "description": ""
22034           },
22035           {
22036             "group": "Body",
22037             "type": "String",
22038             "optional": true,
22039             "field": "createdAt",
22040             "description": ""
22041           },
22042           {
22043             "group": "Body",
22044             "type": "String",
22045             "optional": true,
22046             "field": "updatedAt",
22047             "description": ""
22048           }
22049         ]
22050       }
22051     },
22052     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22053     "version": "0.0.0",
22054     "filename": "server/api/screenRecording/index.js",
22055     "groupTitle": "Screen_Recordings"
22056   },
22057   {
22058     "type": "get",
22059     "url": "/api/screen/recordings/describe",
22060     "title": "Gets table info about Recordings",
22061     "examples": [
22062       {
22063         "title": "Example usage:",
22064         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
22065         "type": "json"
22066       }
22067     ],
22068     "name": "DescribeRecordings",
22069     "group": "Screen_Recordings",
22070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22071     "version": "0.0.0",
22072     "filename": "server/api/screenRecording/index.js",
22073     "groupTitle": "Screen_Recordings"
22074   },
22075   {
22076     "type": "get",
22077     "url": "/api/screen/recordings",
22078     "title": "Gets a list of Recordings",
22079     "examples": [
22080       {
22081         "title": "Example usage:",
22082         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
22083         "type": "json"
22084       }
22085     ],
22086     "name": "GetRecordings",
22087     "group": "Screen_Recordings",
22088     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22089     "version": "0.0.0",
22090     "filename": "server/api/screenRecording/index.js",
22091     "groupTitle": "Screen_Recordings"
22092   },
22093   {
22094     "type": "get",
22095     "url": "/api/screen/recordings/{id}",
22096     "title": "Gets a single Recording",
22097     "examples": [
22098       {
22099         "title": "Example usage:",
22100         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
22101         "type": "json"
22102       }
22103     ],
22104     "name": "ShowRecordings",
22105     "group": "Screen_Recordings",
22106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22107     "version": "0.0.0",
22108     "filename": "server/api/screenRecording/index.js",
22109     "groupTitle": "Screen_Recordings"
22110   },
22111   {
22112     "type": "delete",
22113     "url": "/api/screen/recordings/{id}",
22114     "title": "Delete screen recording",
22115     "examples": [
22116       {
22117         "title": "Example usage:",
22118         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
22119         "type": "json"
22120       }
22121     ],
22122     "name": "destroy",
22123     "group": "Screen_Recordings",
22124     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22125     "version": "0.0.0",
22126     "filename": "server/api/screenRecording/index.js",
22127     "groupTitle": "Screen_Recordings"
22128   },
22129   {
22130     "type": "get",
22131     "url": "/api/screen/recordings/{id}/download",
22132     "title": "Download Recording",
22133     "examples": [
22134       {
22135         "title": "Example usage:",
22136         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
22137         "type": "json"
22138       }
22139     ],
22140     "name": "download",
22141     "group": "Screen_Recordings",
22142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22143     "version": "0.0.0",
22144     "filename": "server/api/screenRecording/index.js",
22145     "groupTitle": "Screen_Recordings"
22146   },
22147   {
22148     "type": "put",
22149     "url": "/api/screen/recordings/{id}",
22150     "title": "Update an existing Recording",
22151     "examples": [
22152       {
22153         "title": "Example usage:",
22154         "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",
22155         "type": "json"
22156       }
22157     ],
22158     "name": "updateRecordings",
22159     "group": "Screen_Recordings",
22160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22161     "version": "0.0.0",
22162     "filename": "server/api/screenRecording/index.js",
22163     "groupTitle": "Screen_Recordings"
22164   },
22165   {
22166     "type": "post",
22167     "url": "/api/integrations/servicenow/accounts",
22168     "title": "Creates a new Servicenow Account",
22169     "examples": [
22170       {
22171         "title": "Example usage:",
22172         "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",
22173         "type": "json"
22174       }
22175     ],
22176     "name": "CreateServicenow_Accounts",
22177     "group": "Servicenow_Accounts",
22178     "parameter": {
22179       "fields": {
22180         "Body": [
22181           {
22182             "group": "Body",
22183             "type": "String",
22184             "optional": true,
22185             "field": "name",
22186             "description": ""
22187           },
22188           {
22189             "group": "Body",
22190             "type": "String",
22191             "optional": true,
22192             "field": "description",
22193             "description": ""
22194           },
22195           {
22196             "group": "Body",
22197             "type": "String",
22198             "optional": true,
22199             "field": "username",
22200             "description": ""
22201           },
22202           {
22203             "group": "Body",
22204             "type": "String",
22205             "optional": true,
22206             "field": "password",
22207             "description": ""
22208           },
22209           {
22210             "group": "Body",
22211             "type": "String",
22212             "optional": true,
22213             "field": "email",
22214             "description": ""
22215           },
22216           {
22217             "group": "Body",
22218             "type": "String",
22219             "optional": true,
22220             "field": "remoteUri",
22221             "description": ""
22222           },
22223           {
22224             "group": "Body",
22225             "type": "String",
22226             "optional": false,
22227             "field": "serverUrl",
22228             "description": ""
22229           }
22230         ]
22231       }
22232     },
22233     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22234     "version": "0.0.0",
22235     "filename": "server/api/intServicenowAccount/index.js",
22236     "groupTitle": "Servicenow_Accounts"
22237   },
22238   {
22239     "type": "delete",
22240     "url": "/api/integrations/servicenow/accounts/{id}",
22241     "title": "Deletes a Servicenow Account",
22242     "examples": [
22243       {
22244         "title": "Example usage:",
22245         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
22246         "type": "json"
22247       }
22248     ],
22249     "name": "DeleteServicenow_Accounts",
22250     "group": "Servicenow_Accounts",
22251     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22252     "version": "0.0.0",
22253     "filename": "server/api/intServicenowAccount/index.js",
22254     "groupTitle": "Servicenow_Accounts"
22255   },
22256   {
22257     "type": "get",
22258     "url": "/api/integrations/servicenow/accounts",
22259     "title": "Gets a list of Servicenow Accounts",
22260     "examples": [
22261       {
22262         "title": "Example usage:",
22263         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
22264         "type": "json"
22265       }
22266     ],
22267     "name": "GetServicenow_Accounts",
22268     "group": "Servicenow_Accounts",
22269     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22270     "version": "0.0.0",
22271     "filename": "server/api/intServicenowAccount/index.js",
22272     "groupTitle": "Servicenow_Accounts"
22273   },
22274   {
22275     "type": "get",
22276     "url": "/api/integrations/servicenow/accounts/{id}",
22277     "title": "Gets a single Servicenow Account",
22278     "examples": [
22279       {
22280         "title": "Example usage:",
22281         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
22282         "type": "json"
22283       }
22284     ],
22285     "name": "ShowServicenow_Accounts",
22286     "group": "Servicenow_Accounts",
22287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22288     "version": "0.0.0",
22289     "filename": "server/api/intServicenowAccount/index.js",
22290     "groupTitle": "Servicenow_Accounts"
22291   },
22292   {
22293     "type": "post",
22294     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22295     "title": "Creates new configuration",
22296     "examples": [
22297       {
22298         "title": "Example usage:",
22299         "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",
22300         "type": "json"
22301       }
22302     ],
22303     "name": "addConfiguration",
22304     "group": "Servicenow_Accounts",
22305     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22306     "version": "0.0.0",
22307     "filename": "server/api/intServicenowAccount/index.js",
22308     "groupTitle": "Servicenow_Accounts"
22309   },
22310   {
22311     "type": "get",
22312     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22313     "title": "Gets account configurations",
22314     "examples": [
22315       {
22316         "title": "Example usage:",
22317         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22318         "type": "json"
22319       }
22320     ],
22321     "name": "getConfigurations",
22322     "group": "Servicenow_Accounts",
22323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22324     "version": "0.0.0",
22325     "filename": "server/api/intServicenowAccount/index.js",
22326     "groupTitle": "Servicenow_Accounts"
22327   },
22328   {
22329     "type": "get",
22330     "url": "/api/integrations/servicenow/accounts/{id}/fields",
22331     "title": "Gets account fields",
22332     "examples": [
22333       {
22334         "title": "Example usage:",
22335         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22336         "type": "json"
22337       }
22338     ],
22339     "name": "getFields",
22340     "group": "Servicenow_Accounts",
22341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22342     "version": "0.0.0",
22343     "filename": "server/api/intServicenowAccount/index.js",
22344     "groupTitle": "Servicenow_Accounts"
22345   },
22346   {
22347     "type": "put",
22348     "url": "/api/integrations/servicenow/accounts/{id}",
22349     "title": "Update an existing Servicenow Account",
22350     "examples": [
22351       {
22352         "title": "Example usage:",
22353         "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",
22354         "type": "json"
22355       }
22356     ],
22357     "name": "updateServicenow_Accounts",
22358     "group": "Servicenow_Accounts",
22359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22360     "version": "0.0.0",
22361     "filename": "server/api/intServicenowAccount/index.js",
22362     "groupTitle": "Servicenow_Accounts"
22363   },
22364   {
22365     "type": "post",
22366     "url": "/api/integrations/servicenow/configurations",
22367     "title": "Creates a new Servicenow Configuration",
22368     "examples": [
22369       {
22370         "title": "Example usage:",
22371         "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",
22372         "type": "json"
22373       }
22374     ],
22375     "name": "CreateServicenow_Configurations",
22376     "group": "Servicenow_Configurations",
22377     "parameter": {
22378       "fields": {
22379         "Body": [
22380           {
22381             "group": "Body",
22382             "type": "String",
22383             "optional": true,
22384             "field": "name",
22385             "description": ""
22386           },
22387           {
22388             "group": "Body",
22389             "type": "String",
22390             "optional": true,
22391             "field": "description",
22392             "description": ""
22393           }
22394         ]
22395       }
22396     },
22397     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22398     "version": "0.0.0",
22399     "filename": "server/api/intServicenowConfiguration/index.js",
22400     "groupTitle": "Servicenow_Configurations"
22401   },
22402   {
22403     "type": "delete",
22404     "url": "/api/integrations/servicenow/configurations/{id}",
22405     "title": "Deletes a Servicenow Configuration",
22406     "examples": [
22407       {
22408         "title": "Example usage:",
22409         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22410         "type": "json"
22411       }
22412     ],
22413     "name": "DeleteServicenow_Configurations",
22414     "group": "Servicenow_Configurations",
22415     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22416     "version": "0.0.0",
22417     "filename": "server/api/intServicenowConfiguration/index.js",
22418     "groupTitle": "Servicenow_Configurations"
22419   },
22420   {
22421     "type": "get",
22422     "url": "/api/integrations/servicenow/configurations",
22423     "title": "Gets a list of Servicenow Configurations",
22424     "examples": [
22425       {
22426         "title": "Example usage:",
22427         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22428         "type": "json"
22429       }
22430     ],
22431     "name": "GetServicenow_Configurations",
22432     "group": "Servicenow_Configurations",
22433     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22434     "version": "0.0.0",
22435     "filename": "server/api/intServicenowConfiguration/index.js",
22436     "groupTitle": "Servicenow_Configurations"
22437   },
22438   {
22439     "type": "get",
22440     "url": "/api/integrations/servicenow/configurations/{id}",
22441     "title": "Gets a single Servicenow Configuration",
22442     "examples": [
22443       {
22444         "title": "Example usage:",
22445         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22446         "type": "json"
22447       }
22448     ],
22449     "name": "ShowServicenow_Configurations",
22450     "group": "Servicenow_Configurations",
22451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22452     "version": "0.0.0",
22453     "filename": "server/api/intServicenowConfiguration/index.js",
22454     "groupTitle": "Servicenow_Configurations"
22455   },
22456   {
22457     "type": "get",
22458     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22459     "title": "Gets configurations descriptions",
22460     "examples": [
22461       {
22462         "title": "Example usage:",
22463         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22464         "type": "json"
22465       }
22466     ],
22467     "name": "getDescriptions",
22468     "group": "Servicenow_Configurations",
22469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22470     "version": "0.0.0",
22471     "filename": "server/api/intServicenowConfiguration/index.js",
22472     "groupTitle": "Servicenow_Configurations"
22473   },
22474   {
22475     "type": "get",
22476     "url": "/api/integrations/servicenow/configurations/{id}/fields",
22477     "title": "Gets configurations fields",
22478     "examples": [
22479       {
22480         "title": "Example usage:",
22481         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22482         "type": "json"
22483       }
22484     ],
22485     "name": "getFields",
22486     "group": "Servicenow_Configurations",
22487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22488     "version": "0.0.0",
22489     "filename": "server/api/intServicenowConfiguration/index.js",
22490     "groupTitle": "Servicenow_Configurations"
22491   },
22492   {
22493     "type": "get",
22494     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22495     "title": "Gets configurations subjects",
22496     "examples": [
22497       {
22498         "title": "Example usage:",
22499         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22500         "type": "json"
22501       }
22502     ],
22503     "name": "getSubjects",
22504     "group": "Servicenow_Configurations",
22505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22506     "version": "0.0.0",
22507     "filename": "server/api/intServicenowConfiguration/index.js",
22508     "groupTitle": "Servicenow_Configurations"
22509   },
22510   {
22511     "type": "put",
22512     "url": "/api/integrations/servicenow/configurations/{id}",
22513     "title": "Update an existing Servicenow Configuration",
22514     "examples": [
22515       {
22516         "title": "Example usage:",
22517         "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",
22518         "type": "json"
22519       }
22520     ],
22521     "name": "updateServicenow_Configurations",
22522     "group": "Servicenow_Configurations",
22523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22524     "version": "0.0.0",
22525     "filename": "server/api/intServicenowConfiguration/index.js",
22526     "groupTitle": "Servicenow_Configurations"
22527   },
22528   {
22529     "type": "post",
22530     "url": "/api/integrations/servicenow/fields",
22531     "title": "Creates a new Servicenow Field",
22532     "examples": [
22533       {
22534         "title": "Example usage:",
22535         "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",
22536         "type": "json"
22537       }
22538     ],
22539     "name": "CreateServicenow_Fields",
22540     "group": "Servicenow_Fields",
22541     "parameter": {
22542       "fields": {
22543         "Body": [
22544           {
22545             "group": "Body",
22546             "type": "String",
22547             "allowedValues": [
22548               "\"string\"",
22549               "\"variable\"",
22550               "\"customVariable\"",
22551               "\"keyValue\"",
22552               "\"picklist\""
22553             ],
22554             "optional": true,
22555             "field": "type",
22556             "description": ""
22557           },
22558           {
22559             "group": "Body",
22560             "type": "String",
22561             "optional": true,
22562             "field": "content",
22563             "description": ""
22564           },
22565           {
22566             "group": "Body",
22567             "type": "String",
22568             "optional": true,
22569             "field": "key",
22570             "description": ""
22571           },
22572           {
22573             "group": "Body",
22574             "type": "String",
22575             "allowedValues": [
22576               "\"string\"",
22577               "\"variable\"",
22578               "\"customVariable\""
22579             ],
22580             "optional": true,
22581             "field": "keyType",
22582             "description": ""
22583           },
22584           {
22585             "group": "Body",
22586             "type": "String",
22587             "optional": true,
22588             "field": "keyContent",
22589             "description": ""
22590           },
22591           {
22592             "group": "Body",
22593             "type": "String",
22594             "optional": true,
22595             "field": "idField",
22596             "description": ""
22597           },
22598           {
22599             "group": "Body",
22600             "type": "String",
22601             "optional": true,
22602             "field": "nameField",
22603             "description": ""
22604           },
22605           {
22606             "group": "Body",
22607             "type": "Boolean",
22608             "optional": true,
22609             "field": "customField",
22610             "description": ""
22611           },
22612           {
22613             "group": "Body",
22614             "type": "String",
22615             "optional": true,
22616             "field": "variableName",
22617             "description": ""
22618           }
22619         ]
22620       }
22621     },
22622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22623     "version": "0.0.0",
22624     "filename": "server/api/intServicenowField/index.js",
22625     "groupTitle": "Servicenow_Fields"
22626   },
22627   {
22628     "type": "delete",
22629     "url": "/api/integrations/servicenow/fields/{id}",
22630     "title": "Deletes a Servicenow Field",
22631     "examples": [
22632       {
22633         "title": "Example usage:",
22634         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22635         "type": "json"
22636       }
22637     ],
22638     "name": "DeleteServicenow_Fields",
22639     "group": "Servicenow_Fields",
22640     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22641     "version": "0.0.0",
22642     "filename": "server/api/intServicenowField/index.js",
22643     "groupTitle": "Servicenow_Fields"
22644   },
22645   {
22646     "type": "get",
22647     "url": "/api/integrations/servicenow/fields",
22648     "title": "Gets a list of Servicenow Fields",
22649     "examples": [
22650       {
22651         "title": "Example usage:",
22652         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22653         "type": "json"
22654       }
22655     ],
22656     "name": "GetServicenow_Fields",
22657     "group": "Servicenow_Fields",
22658     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22659     "version": "0.0.0",
22660     "filename": "server/api/intServicenowField/index.js",
22661     "groupTitle": "Servicenow_Fields"
22662   },
22663   {
22664     "type": "get",
22665     "url": "/api/integrations/servicenow/fields/{id}",
22666     "title": "Gets a single Servicenow Field",
22667     "examples": [
22668       {
22669         "title": "Example usage:",
22670         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22671         "type": "json"
22672       }
22673     ],
22674     "name": "ShowServicenow_Fields",
22675     "group": "Servicenow_Fields",
22676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22677     "version": "0.0.0",
22678     "filename": "server/api/intServicenowField/index.js",
22679     "groupTitle": "Servicenow_Fields"
22680   },
22681   {
22682     "type": "put",
22683     "url": "/api/integrations/servicenow/fields/{id}",
22684     "title": "Update an existing Servicenow Field",
22685     "examples": [
22686       {
22687         "title": "Example usage:",
22688         "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",
22689         "type": "json"
22690       }
22691     ],
22692     "name": "updateServicenow_Fields",
22693     "group": "Servicenow_Fields",
22694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22695     "version": "0.0.0",
22696     "filename": "server/api/intServicenowField/index.js",
22697     "groupTitle": "Servicenow_Fields"
22698   },
22699   {
22700     "type": "get",
22701     "url": "/api/settings",
22702     "title": "Gets a list of Settings",
22703     "examples": [
22704       {
22705         "title": "Example usage:",
22706         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22707         "type": "json"
22708       }
22709     ],
22710     "name": "GetSettings",
22711     "group": "Settings",
22712     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22713     "version": "0.0.0",
22714     "filename": "server/api/setting/index.js",
22715     "groupTitle": "Settings"
22716   },
22717   {
22718     "type": "get",
22719     "url": "/api/settings/{id}",
22720     "title": "Gets a single Setting",
22721     "examples": [
22722       {
22723         "title": "Example usage:",
22724         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22725         "type": "json"
22726       }
22727     ],
22728     "name": "ShowSettings",
22729     "group": "Settings",
22730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22731     "version": "0.0.0",
22732     "filename": "server/api/setting/index.js",
22733     "groupTitle": "Settings"
22734   },
22735   {
22736     "type": "post",
22737     "url": "/api/settings/{id}/favicon",
22738     "title": "Add Favicon",
22739     "examples": [
22740       {
22741         "title": "Example usage:",
22742         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22743         "type": "json"
22744       }
22745     ],
22746     "name": "addFavicon",
22747     "group": "Settings",
22748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22749     "version": "0.0.0",
22750     "filename": "server/api/setting/index.js",
22751     "groupTitle": "Settings"
22752   },
22753   {
22754     "type": "post",
22755     "url": "/api/settings/{id}/logo",
22756     "title": "Add logo",
22757     "examples": [
22758       {
22759         "title": "Example usage:",
22760         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22761         "type": "json"
22762       }
22763     ],
22764     "name": "addLogo",
22765     "group": "Settings",
22766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22767     "version": "0.0.0",
22768     "filename": "server/api/setting/index.js",
22769     "groupTitle": "Settings"
22770   },
22771   {
22772     "type": "post",
22773     "url": "/api/settings/{id}/logo_login",
22774     "title": "Add logo login",
22775     "examples": [
22776       {
22777         "title": "Example usage:",
22778         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22779         "type": "json"
22780       }
22781     ],
22782     "name": "addLogoLogin",
22783     "group": "Settings",
22784     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22785     "version": "0.0.0",
22786     "filename": "server/api/setting/index.js",
22787     "groupTitle": "Settings"
22788   },
22789   {
22790     "type": "post",
22791     "url": "/api/settings/{id}/preferred",
22792     "title": "Add Preferred",
22793     "examples": [
22794       {
22795         "title": "Example usage:",
22796         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22797         "type": "json"
22798       }
22799     ],
22800     "name": "addPreferred",
22801     "group": "Settings",
22802     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22803     "version": "0.0.0",
22804     "filename": "server/api/setting/index.js",
22805     "groupTitle": "Settings"
22806   },
22807   {
22808     "type": "get",
22809     "url": "/api/settings/now",
22810     "title": "Get Server Current Date",
22811     "examples": [
22812       {
22813         "title": "Example usage:",
22814         "content": "curl https://{domain}/api/settings/now -v -X GET",
22815         "type": "json"
22816       }
22817     ],
22818     "name": "getDate",
22819     "group": "Settings",
22820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22821     "version": "0.0.0",
22822     "filename": "server/api/setting/index.js",
22823     "groupTitle": "Settings"
22824   },
22825   {
22826     "type": "get",
22827     "url": "/api/settings/{id}/favicon",
22828     "title": "Get Favicon",
22829     "examples": [
22830       {
22831         "title": "Example usage:",
22832         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22833         "type": "json"
22834       }
22835     ],
22836     "name": "getFavicon",
22837     "group": "Settings",
22838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22839     "version": "0.0.0",
22840     "filename": "server/api/setting/index.js",
22841     "groupTitle": "Settings"
22842   },
22843   {
22844     "type": "get",
22845     "url": "/api/settings/{id}/gdpr",
22846     "title": "Get gdpr settings",
22847     "examples": [
22848       {
22849         "title": "Example usage:",
22850         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22851         "type": "json"
22852       }
22853     ],
22854     "name": "getGdpr",
22855     "group": "Settings",
22856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22857     "version": "0.0.0",
22858     "filename": "server/api/setting/index.js",
22859     "groupTitle": "Settings"
22860   },
22861   {
22862     "type": "get",
22863     "url": "/api/settings/{id}/logo",
22864     "title": "Get logo",
22865     "examples": [
22866       {
22867         "title": "Example usage:",
22868         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22869         "type": "json"
22870       }
22871     ],
22872     "name": "getLogo",
22873     "group": "Settings",
22874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22875     "version": "0.0.0",
22876     "filename": "server/api/setting/index.js",
22877     "groupTitle": "Settings"
22878   },
22879   {
22880     "type": "get",
22881     "url": "/api/settings/{id}/logo_login",
22882     "title": "Get logo login",
22883     "examples": [
22884       {
22885         "title": "Example usage:",
22886         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22887         "type": "json"
22888       }
22889     ],
22890     "name": "getLogoLogin",
22891     "group": "Settings",
22892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22893     "version": "0.0.0",
22894     "filename": "server/api/setting/index.js",
22895     "groupTitle": "Settings"
22896   },
22897   {
22898     "type": "get",
22899     "url": "/api/settings/{id}/preferred",
22900     "title": "Get Preferred",
22901     "examples": [
22902       {
22903         "title": "Example usage:",
22904         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22905         "type": "json"
22906       }
22907     ],
22908     "name": "getPreferred",
22909     "group": "Settings",
22910     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22911     "version": "0.0.0",
22912     "filename": "server/api/setting/index.js",
22913     "groupTitle": "Settings"
22914   },
22915   {
22916     "type": "put",
22917     "url": "/api/settings/{id}",
22918     "title": "Update an existing Setting",
22919     "examples": [
22920       {
22921         "title": "Example usage:",
22922         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22923         "type": "json"
22924       }
22925     ],
22926     "name": "updateSettings",
22927     "group": "Settings",
22928     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22929     "version": "0.0.0",
22930     "filename": "server/api/setting/index.js",
22931     "groupTitle": "Settings"
22932   },
22933   {
22934     "type": "post",
22935     "url": "/api/sms/accounts/{id}/users",
22936     "title": "Add agents to a sms account",
22937     "examples": [
22938       {
22939         "title": "Example usage:",
22940         "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",
22941         "type": "json"
22942       }
22943     ],
22944     "name": "AddAgents",
22945     "group": "Sms_Accounts",
22946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22947     "version": "0.0.0",
22948     "filename": "server/api/smsAccount/index.js",
22949     "groupTitle": "Sms_Accounts"
22950   },
22951   {
22952     "type": "post",
22953     "url": "/api/sms/accounts",
22954     "title": "Creates a new Account",
22955     "examples": [
22956       {
22957         "title": "Example usage:",
22958         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22959         "type": "json"
22960       }
22961     ],
22962     "name": "CreateAccounts",
22963     "group": "Sms_Accounts",
22964     "parameter": {
22965       "fields": {
22966         "Body": [
22967           {
22968             "group": "Body",
22969             "type": "String",
22970             "optional": false,
22971             "field": "name",
22972             "description": ""
22973           },
22974           {
22975             "group": "Body",
22976             "type": "String",
22977             "optional": false,
22978             "field": "key",
22979             "description": ""
22980           },
22981           {
22982             "group": "Body",
22983             "type": "String",
22984             "optional": false,
22985             "field": "remote",
22986             "description": ""
22987           },
22988           {
22989             "group": "Body",
22990             "type": "String",
22991             "optional": true,
22992             "field": "token",
22993             "description": ""
22994           },
22995           {
22996             "group": "Body",
22997             "type": "String",
22998             "optional": true,
22999             "field": "phone",
23000             "description": ""
23001           },
23002           {
23003             "group": "Body",
23004             "type": "String",
23005             "allowedValues": [
23006               "\"twilio\"",
23007               "\"skebby\"",
23008               "\"connectel\"",
23009               "\"clicksend\"",
23010               "\"plivo\"",
23011               "\"clickatell\"",
23012               "\"bandwidth\"",
23013               "\"csc\"",
23014               "\"infobip\"",
23015               "\"intelepeer\""
23016             ],
23017             "optional": true,
23018             "field": "type",
23019             "description": ""
23020           },
23021           {
23022             "group": "Body",
23023             "type": "String",
23024             "optional": true,
23025             "field": "accountSid",
23026             "description": ""
23027           },
23028           {
23029             "group": "Body",
23030             "type": "String",
23031             "optional": true,
23032             "field": "authId",
23033             "description": ""
23034           },
23035           {
23036             "group": "Body",
23037             "type": "String",
23038             "optional": true,
23039             "field": "authToken",
23040             "description": ""
23041           },
23042           {
23043             "group": "Body",
23044             "type": "String",
23045             "allowedValues": [
23046               "\"SI\"",
23047               "\"TI\"",
23048               "\"GP\""
23049             ],
23050             "optional": true,
23051             "field": "smsMethod",
23052             "description": ""
23053           },
23054           {
23055             "group": "Body",
23056             "type": "String",
23057             "optional": true,
23058             "field": "username",
23059             "description": ""
23060           },
23061           {
23062             "group": "Body",
23063             "type": "String",
23064             "optional": true,
23065             "field": "password",
23066             "description": ""
23067           },
23068           {
23069             "group": "Body",
23070             "type": "String",
23071             "optional": true,
23072             "field": "apiKey",
23073             "description": ""
23074           },
23075           {
23076             "group": "Body",
23077             "type": "String",
23078             "optional": true,
23079             "field": "applicationId",
23080             "description": ""
23081           },
23082           {
23083             "group": "Body",
23084             "type": "String",
23085             "optional": true,
23086             "field": "accountId",
23087             "description": ""
23088           },
23089           {
23090             "group": "Body",
23091             "type": "String",
23092             "optional": true,
23093             "field": "senderString",
23094             "description": ""
23095           },
23096           {
23097             "group": "Body",
23098             "type": "Boolean",
23099             "optional": true,
23100             "field": "deliveryReport",
23101             "description": ""
23102           },
23103           {
23104             "group": "Body",
23105             "type": "String",
23106             "optional": true,
23107             "field": "description",
23108             "description": ""
23109           },
23110           {
23111             "group": "Body",
23112             "type": "Text",
23113             "optional": true,
23114             "field": "notificationTemplate",
23115             "description": ""
23116           },
23117           {
23118             "group": "Body",
23119             "type": "Boolean",
23120             "optional": true,
23121             "field": "notificationSound",
23122             "description": ""
23123           },
23124           {
23125             "group": "Body",
23126             "type": "Boolean",
23127             "optional": true,
23128             "field": "notificationShake",
23129             "description": ""
23130           },
23131           {
23132             "group": "Body",
23133             "type": "Integer",
23134             "optional": true,
23135             "field": "waitForTheAssignedAgent",
23136             "description": ""
23137           },
23138           {
23139             "group": "Body",
23140             "type": "Integer",
23141             "optional": true,
23142             "field": "waitForTheAssignedQueue",
23143             "description": ""
23144           },
23145           {
23146             "group": "Body",
23147             "type": "Boolean",
23148             "optional": true,
23149             "field": "queueTransfer",
23150             "description": ""
23151           },
23152           {
23153             "group": "Body",
23154             "type": "Integer",
23155             "optional": true,
23156             "field": "queueTransferTimeout",
23157             "description": ""
23158           },
23159           {
23160             "group": "Body",
23161             "type": "Boolean",
23162             "optional": true,
23163             "field": "agentTransfer",
23164             "description": ""
23165           },
23166           {
23167             "group": "Body",
23168             "type": "Integer",
23169             "optional": true,
23170             "field": "agentTransferTimeout",
23171             "description": ""
23172           },
23173           {
23174             "group": "Body",
23175             "type": "String",
23176             "optional": true,
23177             "field": "baseUrl",
23178             "description": ""
23179           },
23180           {
23181             "group": "Body",
23182             "type": "Integer",
23183             "optional": true,
23184             "field": "mandatoryDispositionPauseId",
23185             "description": "<p>Status to put when mandatory disposition is enabled</p>"
23186           },
23187           {
23188             "group": "Body",
23189             "type": "Boolean",
23190             "optional": true,
23191             "field": "mandatoryDisposition",
23192             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
23193           }
23194         ]
23195       }
23196     },
23197     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23198     "version": "0.0.0",
23199     "filename": "server/api/smsAccount/index.js",
23200     "groupTitle": "Sms_Accounts"
23201   },
23202   {
23203     "type": "delete",
23204     "url": "/api/sms/accounts/{id}",
23205     "title": "Deletes a Account",
23206     "examples": [
23207       {
23208         "title": "Example usage:",
23209         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
23210         "type": "json"
23211       }
23212     ],
23213     "name": "DeleteAccounts",
23214     "group": "Sms_Accounts",
23215     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23216     "version": "0.0.0",
23217     "filename": "server/api/smsAccount/index.js",
23218     "groupTitle": "Sms_Accounts"
23219   },
23220   {
23221     "type": "get",
23222     "url": "/api/sms/accounts/describe",
23223     "title": "Gets table info about Accounts",
23224     "examples": [
23225       {
23226         "title": "Example usage:",
23227         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
23228         "type": "json"
23229       }
23230     ],
23231     "name": "DescribeAccounts",
23232     "group": "Sms_Accounts",
23233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23234     "version": "0.0.0",
23235     "filename": "server/api/smsAccount/index.js",
23236     "groupTitle": "Sms_Accounts"
23237   },
23238   {
23239     "type": "get",
23240     "url": "/api/sms/accounts",
23241     "title": "Gets a list of Accounts",
23242     "examples": [
23243       {
23244         "title": "Example usage:",
23245         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
23246         "type": "json"
23247       }
23248     ],
23249     "name": "GetAccounts",
23250     "group": "Sms_Accounts",
23251     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23252     "version": "0.0.0",
23253     "filename": "server/api/smsAccount/index.js",
23254     "groupTitle": "Sms_Accounts"
23255   },
23256   {
23257     "type": "get",
23258     "url": "/api/sms/accounts/{id}/users",
23259     "title": "Gets agents from sms account",
23260     "examples": [
23261       {
23262         "title": "Example usage:",
23263         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
23264         "type": "json"
23265       }
23266     ],
23267     "name": "GetAgents",
23268     "group": "Sms_Accounts",
23269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23270     "version": "0.0.0",
23271     "filename": "server/api/smsAccount/index.js",
23272     "groupTitle": "Sms_Accounts"
23273   },
23274   {
23275     "type": "delete",
23276     "url": "/api/sms/accounts/{id}/users",
23277     "title": "Removes agents from a sms account",
23278     "examples": [
23279       {
23280         "title": "Example usage:",
23281         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23282         "type": "json"
23283       }
23284     ],
23285     "name": "RemoveAgents",
23286     "group": "Sms_Accounts",
23287     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23288     "version": "0.0.0",
23289     "filename": "server/api/smsAccount/index.js",
23290     "groupTitle": "Sms_Accounts"
23291   },
23292   {
23293     "type": "delete",
23294     "url": "/api/sms/accounts/{id}/canned_answers",
23295     "title": "Removes canned answers from account",
23296     "examples": [
23297       {
23298         "title": "Example usage:",
23299         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23300         "type": "json"
23301       }
23302     ],
23303     "name": "RemoveAnswers",
23304     "group": "Sms_Accounts",
23305     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23306     "version": "0.0.0",
23307     "filename": "server/api/smsAccount/index.js",
23308     "groupTitle": "Sms_Accounts"
23309   },
23310   {
23311     "type": "delete",
23312     "url": "/api/sms/accounts/{id}/dispositions",
23313     "title": "Removes dispositions from account",
23314     "examples": [
23315       {
23316         "title": "Example usage:",
23317         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23318         "type": "json"
23319       }
23320     ],
23321     "name": "RemoveDispositions",
23322     "group": "Sms_Accounts",
23323     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23324     "version": "0.0.0",
23325     "filename": "server/api/smsAccount/index.js",
23326     "groupTitle": "Sms_Accounts"
23327   },
23328   {
23329     "type": "get",
23330     "url": "/api/sms/accounts/{id}",
23331     "title": "Gets a single Account",
23332     "examples": [
23333       {
23334         "title": "Example usage:",
23335         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23336         "type": "json"
23337       }
23338     ],
23339     "name": "ShowAccounts",
23340     "group": "Sms_Accounts",
23341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23342     "version": "0.0.0",
23343     "filename": "server/api/smsAccount/index.js",
23344     "groupTitle": "Sms_Accounts"
23345   },
23346   {
23347     "type": "put",
23348     "url": "/api/sms/messages/{id}/accept",
23349     "title": "Accepts message",
23350     "examples": [
23351       {
23352         "title": "Example usage:",
23353         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23354         "type": "json"
23355       }
23356     ],
23357     "name": "acceptMessage",
23358     "group": "Sms_Accounts",
23359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23360     "version": "0.0.0",
23361     "filename": "server/api/smsMessage/index.js",
23362     "groupTitle": "Sms_Accounts"
23363   },
23364   {
23365     "type": "post",
23366     "url": "/api/sms/accounts/{id}/canned_answers",
23367     "title": "Creates new canned answer",
23368     "examples": [
23369       {
23370         "title": "Example usage:",
23371         "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",
23372         "type": "json"
23373       }
23374     ],
23375     "name": "addAnswer",
23376     "group": "Sms_Accounts",
23377     "parameter": {
23378       "fields": {
23379         "Body": [
23380           {
23381             "group": "Body",
23382             "type": "String",
23383             "optional": false,
23384             "field": "key",
23385             "description": ""
23386           },
23387           {
23388             "group": "Body",
23389             "type": "Text",
23390             "optional": false,
23391             "field": "value",
23392             "description": ""
23393           },
23394           {
23395             "group": "Body",
23396             "type": "String",
23397             "optional": true,
23398             "field": "description",
23399             "description": ""
23400           },
23401           {
23402             "group": "Body",
23403             "type": "Virtual",
23404             "optional": true,
23405             "field": "name",
23406             "description": ""
23407           }
23408         ]
23409       }
23410     },
23411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23412     "version": "0.0.0",
23413     "filename": "server/api/smsAccount/index.js",
23414     "groupTitle": "Sms_Accounts"
23415   },
23416   {
23417     "type": "post",
23418     "url": "/api/sms/accounts/{id}/applications",
23419     "title": "Creates new applications",
23420     "examples": [
23421       {
23422         "title": "Example usage:",
23423         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23424         "type": "json"
23425       }
23426     ],
23427     "name": "addApplications",
23428     "group": "Sms_Accounts",
23429     "parameter": {
23430       "fields": {
23431         "Body": [
23432           {
23433             "group": "Body",
23434             "type": "Integer",
23435             "optional": false,
23436             "field": "priority",
23437             "description": ""
23438           },
23439           {
23440             "group": "Body",
23441             "type": "String",
23442             "optional": false,
23443             "field": "app",
23444             "description": ""
23445           },
23446           {
23447             "group": "Body",
23448             "type": "Text",
23449             "optional": true,
23450             "field": "appdata",
23451             "description": ""
23452           },
23453           {
23454             "group": "Body",
23455             "type": "String",
23456             "optional": true,
23457             "field": "description",
23458             "description": ""
23459           },
23460           {
23461             "group": "Body",
23462             "type": "String",
23463             "optional": true,
23464             "field": "interval",
23465             "description": ""
23466           }
23467         ]
23468       }
23469     },
23470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23471     "version": "0.0.0",
23472     "filename": "server/api/smsAccount/index.js",
23473     "groupTitle": "Sms_Accounts"
23474   },
23475   {
23476     "type": "post",
23477     "url": "/api/sms/accounts/{id}/dispositions",
23478     "title": "Creates new disposition",
23479     "examples": [
23480       {
23481         "title": "Example usage:",
23482         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23483         "type": "json"
23484       }
23485     ],
23486     "name": "addDisposition",
23487     "group": "Sms_Accounts",
23488     "parameter": {
23489       "fields": {
23490         "Body": [
23491           {
23492             "group": "Body",
23493             "type": "String",
23494             "optional": false,
23495             "field": "name",
23496             "description": ""
23497           },
23498           {
23499             "group": "Body",
23500             "type": "String",
23501             "allowedValues": [
23502               "\"first\"",
23503               "\"second\"",
23504               "\"third\""
23505             ],
23506             "optional": false,
23507             "field": "level",
23508             "description": ""
23509           },
23510           {
23511             "group": "Body",
23512             "type": "String",
23513             "optional": true,
23514             "field": "description",
23515             "description": ""
23516           }
23517         ]
23518       }
23519     },
23520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23521     "version": "0.0.0",
23522     "filename": "server/api/smsAccount/index.js",
23523     "groupTitle": "Sms_Accounts"
23524   },
23525   {
23526     "type": "get",
23527     "url": "/api/sms/accounts/{id}/canned_answers",
23528     "title": "Gets account canned answers",
23529     "examples": [
23530       {
23531         "title": "Example usage:",
23532         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23533         "type": "json"
23534       }
23535     ],
23536     "name": "getAnswers",
23537     "group": "Sms_Accounts",
23538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23539     "version": "0.0.0",
23540     "filename": "server/api/smsAccount/index.js",
23541     "groupTitle": "Sms_Accounts"
23542   },
23543   {
23544     "type": "get",
23545     "url": "/api/sms/accounts/{id}/applications",
23546     "title": "Gets account applications",
23547     "examples": [
23548       {
23549         "title": "Example usage:",
23550         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23551         "type": "json"
23552       }
23553     ],
23554     "name": "getApplications",
23555     "group": "Sms_Accounts",
23556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23557     "version": "0.0.0",
23558     "filename": "server/api/smsAccount/index.js",
23559     "groupTitle": "Sms_Accounts"
23560   },
23561   {
23562     "type": "get",
23563     "url": "/api/sms/accounts/{id}/dispositions",
23564     "title": "Gets account dispositions",
23565     "examples": [
23566       {
23567         "title": "Example usage:",
23568         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23569         "type": "json"
23570       }
23571     ],
23572     "name": "getDispositions",
23573     "group": "Sms_Accounts",
23574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23575     "version": "0.0.0",
23576     "filename": "server/api/smsAccount/index.js",
23577     "groupTitle": "Sms_Accounts"
23578   },
23579   {
23580     "type": "get",
23581     "url": "/api/sms/accounts/{id}/interactions",
23582     "title": "Gets Sms Account interactions",
23583     "examples": [
23584       {
23585         "title": "Example usage:",
23586         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23587         "type": "json"
23588       }
23589     ],
23590     "name": "getInteractions",
23591     "group": "Sms_Accounts",
23592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23593     "version": "0.0.0",
23594     "filename": "server/api/smsAccount/index.js",
23595     "groupTitle": "Sms_Accounts"
23596   },
23597   {
23598     "type": "post",
23599     "url": "/api/sms/accounts/{id}/notify",
23600     "title": "Notify new message",
23601     "examples": [
23602       {
23603         "title": "Example usage:",
23604         "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",
23605         "type": "json"
23606       }
23607     ],
23608     "name": "notify",
23609     "group": "Sms_Accounts",
23610     "description": "<p>Motion 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>",
23611     "version": "0.0.0",
23612     "filename": "server/api/smsAccount/index.js",
23613     "groupTitle": "Sms_Accounts"
23614   },
23615   {
23616     "type": "put",
23617     "url": "/api/sms/messages/{id}/reject",
23618     "title": "Rejects message",
23619     "examples": [
23620       {
23621         "title": "Example usage:",
23622         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23623         "type": "json"
23624       }
23625     ],
23626     "name": "rejectMessage",
23627     "group": "Sms_Accounts",
23628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23629     "version": "0.0.0",
23630     "filename": "server/api/smsMessage/index.js",
23631     "groupTitle": "Sms_Accounts"
23632   },
23633   {
23634     "type": "post",
23635     "url": "/api/sms/accounts/{id}/send",
23636     "title": "Send new sms message",
23637     "examples": [
23638       {
23639         "title": "Example usage:",
23640         "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",
23641         "type": "json"
23642       }
23643     ],
23644     "name": "sendSms",
23645     "group": "Sms_Accounts",
23646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23647     "version": "0.0.0",
23648     "filename": "server/api/smsAccount/index.js",
23649     "groupTitle": "Sms_Accounts"
23650   },
23651   {
23652     "type": "get",
23653     "url": "/api/sms/accounts/{id}/status",
23654     "title": "Receive message status as get request",
23655     "examples": [
23656       {
23657         "title": "Example usage:",
23658         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23659         "type": "json"
23660       }
23661     ],
23662     "name": "statusMessage",
23663     "group": "Sms_Accounts",
23664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23665     "version": "0.0.0",
23666     "filename": "server/api/smsAccount/index.js",
23667     "groupTitle": "Sms_Accounts"
23668   },
23669   {
23670     "type": "post",
23671     "url": "/api/sms/accounts/{id}/status",
23672     "title": "Receive message status",
23673     "examples": [
23674       {
23675         "title": "Example usage:",
23676         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23677         "type": "json"
23678       }
23679     ],
23680     "name": "statusMessage",
23681     "group": "Sms_Accounts",
23682     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23683     "version": "0.0.0",
23684     "filename": "server/api/smsAccount/index.js",
23685     "groupTitle": "Sms_Accounts"
23686   },
23687   {
23688     "type": "post",
23689     "url": "/api/sms/messages/{id}/status",
23690     "title": "Receive message status",
23691     "examples": [
23692       {
23693         "title": "Example usage:",
23694         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23695         "type": "json"
23696       }
23697     ],
23698     "name": "statusMessage",
23699     "group": "Sms_Accounts",
23700     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23701     "version": "0.0.0",
23702     "filename": "server/api/smsMessage/index.js",
23703     "groupTitle": "Sms_Accounts"
23704   },
23705   {
23706     "type": "put",
23707     "url": "/api/sms/accounts/{id}",
23708     "title": "Update an existing Account",
23709     "examples": [
23710       {
23711         "title": "Example usage:",
23712         "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",
23713         "type": "json"
23714       }
23715     ],
23716     "name": "updateAccounts",
23717     "group": "Sms_Accounts",
23718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23719     "version": "0.0.0",
23720     "filename": "server/api/smsAccount/index.js",
23721     "groupTitle": "Sms_Accounts"
23722   },
23723   {
23724     "type": "post",
23725     "url": "/api/sms/applications",
23726     "title": "Creates a new Application",
23727     "examples": [
23728       {
23729         "title": "Example usage:",
23730         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23731         "type": "json"
23732       }
23733     ],
23734     "name": "CreateApplications",
23735     "group": "Sms_Applications",
23736     "parameter": {
23737       "fields": {
23738         "Body": [
23739           {
23740             "group": "Body",
23741             "type": "Integer",
23742             "optional": false,
23743             "field": "priority",
23744             "description": ""
23745           },
23746           {
23747             "group": "Body",
23748             "type": "String",
23749             "optional": false,
23750             "field": "app",
23751             "description": ""
23752           },
23753           {
23754             "group": "Body",
23755             "type": "Text",
23756             "optional": true,
23757             "field": "appdata",
23758             "description": ""
23759           },
23760           {
23761             "group": "Body",
23762             "type": "String",
23763             "optional": true,
23764             "field": "description",
23765             "description": ""
23766           },
23767           {
23768             "group": "Body",
23769             "type": "String",
23770             "optional": true,
23771             "field": "interval",
23772             "description": ""
23773           }
23774         ]
23775       }
23776     },
23777     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23778     "version": "0.0.0",
23779     "filename": "server/api/smsApplication/index.js",
23780     "groupTitle": "Sms_Applications"
23781   },
23782   {
23783     "type": "delete",
23784     "url": "/api/sms/applications/{id}",
23785     "title": "Deletes a Application",
23786     "examples": [
23787       {
23788         "title": "Example usage:",
23789         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23790         "type": "json"
23791       }
23792     ],
23793     "name": "DeleteApplications",
23794     "group": "Sms_Applications",
23795     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23796     "version": "0.0.0",
23797     "filename": "server/api/smsApplication/index.js",
23798     "groupTitle": "Sms_Applications"
23799   },
23800   {
23801     "type": "get",
23802     "url": "/api/sms/applications",
23803     "title": "Gets a list of Applications",
23804     "examples": [
23805       {
23806         "title": "Example usage:",
23807         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23808         "type": "json"
23809       }
23810     ],
23811     "name": "GetApplications",
23812     "group": "Sms_Applications",
23813     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23814     "version": "0.0.0",
23815     "filename": "server/api/smsApplication/index.js",
23816     "groupTitle": "Sms_Applications"
23817   },
23818   {
23819     "type": "get",
23820     "url": "/api/sms/applications/{id}",
23821     "title": "Gets a single Application",
23822     "examples": [
23823       {
23824         "title": "Example usage:",
23825         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23826         "type": "json"
23827       }
23828     ],
23829     "name": "ShowApplications",
23830     "group": "Sms_Applications",
23831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23832     "version": "0.0.0",
23833     "filename": "server/api/smsApplication/index.js",
23834     "groupTitle": "Sms_Applications"
23835   },
23836   {
23837     "type": "put",
23838     "url": "/api/sms/applications/{id}",
23839     "title": "Update an existing Application",
23840     "examples": [
23841       {
23842         "title": "Example usage:",
23843         "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",
23844         "type": "json"
23845       }
23846     ],
23847     "name": "updateApplications",
23848     "group": "Sms_Applications",
23849     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23850     "version": "0.0.0",
23851     "filename": "server/api/smsApplication/index.js",
23852     "groupTitle": "Sms_Applications"
23853   },
23854   {
23855     "type": "post",
23856     "url": "/api/sms/interactions/{id}/tags",
23857     "title": "Add tags to the interaction",
23858     "examples": [
23859       {
23860         "title": "Example usage:",
23861         "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",
23862         "type": "json"
23863       }
23864     ],
23865     "name": "AddTags",
23866     "group": "Sms_Interactions",
23867     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23868     "version": "0.0.0",
23869     "filename": "server/api/smsInteraction/index.js",
23870     "groupTitle": "Sms_Interactions"
23871   },
23872   {
23873     "type": "post",
23874     "url": "/api/sms/interactions",
23875     "title": "Creates a new Interaction",
23876     "examples": [
23877       {
23878         "title": "Example usage:",
23879         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23880         "type": "json"
23881       }
23882     ],
23883     "name": "CreateInteractions",
23884     "group": "Sms_Interactions",
23885     "parameter": {
23886       "fields": {
23887         "Body": [
23888           {
23889             "group": "Body",
23890             "type": "Boolean",
23891             "optional": true,
23892             "field": "closed",
23893             "description": ""
23894           },
23895           {
23896             "group": "Body",
23897             "type": "String",
23898             "optional": true,
23899             "field": "closedAt",
23900             "description": ""
23901           },
23902           {
23903             "group": "Body",
23904             "type": "String",
23905             "optional": true,
23906             "field": "disposition",
23907             "description": ""
23908           },
23909           {
23910             "group": "Body",
23911             "type": "String",
23912             "optional": true,
23913             "field": "secondDisposition",
23914             "description": ""
23915           },
23916           {
23917             "group": "Body",
23918             "type": "String",
23919             "optional": true,
23920             "field": "thirdDisposition",
23921             "description": ""
23922           },
23923           {
23924             "group": "Body",
23925             "type": "String",
23926             "optional": true,
23927             "field": "note",
23928             "description": ""
23929           },
23930           {
23931             "group": "Body",
23932             "type": "String",
23933             "optional": true,
23934             "field": "phone",
23935             "description": ""
23936           },
23937           {
23938             "group": "Body",
23939             "type": "String",
23940             "optional": true,
23941             "field": "read1stAt",
23942             "description": ""
23943           },
23944           {
23945             "group": "Body",
23946             "type": "String",
23947             "allowedValues": [
23948               "\"in\"",
23949               "\"out\""
23950             ],
23951             "optional": false,
23952             "field": "firstMsgDirection",
23953             "description": ""
23954           },
23955           {
23956             "group": "Body",
23957             "type": "String",
23958             "optional": true,
23959             "field": "lastMsgAt",
23960             "description": ""
23961           },
23962           {
23963             "group": "Body",
23964             "type": "String",
23965             "allowedValues": [
23966               "\"in\"",
23967               "\"out\""
23968             ],
23969             "optional": false,
23970             "field": "lastMsgDirection",
23971             "description": ""
23972           },
23973           {
23974             "group": "Body",
23975             "type": "Boolean",
23976             "optional": true,
23977             "field": "autoreplyExecuted",
23978             "description": ""
23979           }
23980         ]
23981       }
23982     },
23983     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23984     "version": "0.0.0",
23985     "filename": "server/api/smsInteraction/index.js",
23986     "groupTitle": "Sms_Interactions"
23987   },
23988   {
23989     "type": "delete",
23990     "url": "/api/sms/interactions/{id}",
23991     "title": "Deletes a Interaction",
23992     "examples": [
23993       {
23994         "title": "Example usage:",
23995         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23996         "type": "json"
23997       }
23998     ],
23999     "name": "DeleteInteractions",
24000     "group": "Sms_Interactions",
24001     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24002     "version": "0.0.0",
24003     "filename": "server/api/smsInteraction/index.js",
24004     "groupTitle": "Sms_Interactions"
24005   },
24006   {
24007     "type": "get",
24008     "url": "/api/sms/interactions/describe",
24009     "title": "Gets table info about Interactions",
24010     "examples": [
24011       {
24012         "title": "Example usage:",
24013         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
24014         "type": "json"
24015       }
24016     ],
24017     "name": "DescribeInteractions",
24018     "group": "Sms_Interactions",
24019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24020     "version": "0.0.0",
24021     "filename": "server/api/smsInteraction/index.js",
24022     "groupTitle": "Sms_Interactions"
24023   },
24024   {
24025     "type": "get",
24026     "url": "/api/sms/interactions",
24027     "title": "Gets a list of Interactions",
24028     "examples": [
24029       {
24030         "title": "Example usage:",
24031         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
24032         "type": "json"
24033       }
24034     ],
24035     "name": "GetInteractions",
24036     "group": "Sms_Interactions",
24037     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24038     "version": "0.0.0",
24039     "filename": "server/api/smsInteraction/index.js",
24040     "groupTitle": "Sms_Interactions"
24041   },
24042   {
24043     "type": "delete",
24044     "url": "/api/sms/interactions/{id}/tags",
24045     "title": "Removes tags from interaction",
24046     "examples": [
24047       {
24048         "title": "Example usage:",
24049         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24050         "type": "json"
24051       }
24052     ],
24053     "name": "RemoveTags",
24054     "group": "Sms_Interactions",
24055     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24056     "version": "0.0.0",
24057     "filename": "server/api/smsInteraction/index.js",
24058     "groupTitle": "Sms_Interactions"
24059   },
24060   {
24061     "type": "get",
24062     "url": "/api/sms/interactions/{id}",
24063     "title": "Gets a single Interaction",
24064     "examples": [
24065       {
24066         "title": "Example usage:",
24067         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
24068         "type": "json"
24069       }
24070     ],
24071     "name": "ShowInteractions",
24072     "group": "Sms_Interactions",
24073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24074     "version": "0.0.0",
24075     "filename": "server/api/smsInteraction/index.js",
24076     "groupTitle": "Sms_Interactions"
24077   },
24078   {
24079     "type": "post",
24080     "url": "/api/sms/interactions/{id}/messages",
24081     "title": "Creates new messages",
24082     "examples": [
24083       {
24084         "title": "Example usage:",
24085         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24086         "type": "json"
24087       }
24088     ],
24089     "name": "addMessage",
24090     "group": "Sms_Interactions",
24091     "parameter": {
24092       "fields": {
24093         "Body": [
24094           {
24095             "group": "Body",
24096             "type": "Text",
24097             "optional": false,
24098             "field": "body",
24099             "description": ""
24100           },
24101           {
24102             "group": "Body",
24103             "type": "Boolean",
24104             "optional": true,
24105             "field": "read",
24106             "description": ""
24107           },
24108           {
24109             "group": "Body",
24110             "type": "String",
24111             "allowedValues": [
24112               "\"in\"",
24113               "\"out\""
24114             ],
24115             "optional": false,
24116             "field": "direction",
24117             "description": ""
24118           },
24119           {
24120             "group": "Body",
24121             "type": "String",
24122             "optional": true,
24123             "field": "messageId",
24124             "description": ""
24125           },
24126           {
24127             "group": "Body",
24128             "type": "String",
24129             "optional": true,
24130             "field": "phone",
24131             "description": ""
24132           },
24133           {
24134             "group": "Body",
24135             "type": "String",
24136             "optional": true,
24137             "field": "readAt",
24138             "description": ""
24139           },
24140           {
24141             "group": "Body",
24142             "type": "Boolean",
24143             "optional": true,
24144             "field": "secret",
24145             "description": ""
24146           },
24147           {
24148             "group": "Body",
24149             "type": "String",
24150             "optional": true,
24151             "field": "providerName",
24152             "description": ""
24153           },
24154           {
24155             "group": "Body",
24156             "type": "Text",
24157             "optional": true,
24158             "field": "providerResponse",
24159             "description": ""
24160           }
24161         ]
24162       }
24163     },
24164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24165     "version": "0.0.0",
24166     "filename": "server/api/smsInteraction/index.js",
24167     "groupTitle": "Sms_Interactions"
24168   },
24169   {
24170     "type": "get",
24171     "url": "/api/sms/interactions/{id}/download",
24172     "title": "Gets interaction",
24173     "examples": [
24174       {
24175         "title": "Example usage:",
24176         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
24177         "type": "json"
24178       }
24179     ],
24180     "name": "download",
24181     "group": "Sms_Interactions",
24182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24183     "version": "0.0.0",
24184     "filename": "server/api/smsInteraction/index.js",
24185     "groupTitle": "Sms_Interactions"
24186   },
24187   {
24188     "type": "get",
24189     "url": "/api/sms/interactions/{id}/messages",
24190     "title": "Gets interaction messages",
24191     "examples": [
24192       {
24193         "title": "Example usage:",
24194         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
24195         "type": "json"
24196       }
24197     ],
24198     "name": "getMessages",
24199     "group": "Sms_Interactions",
24200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24201     "version": "0.0.0",
24202     "filename": "server/api/smsInteraction/index.js",
24203     "groupTitle": "Sms_Interactions"
24204   },
24205   {
24206     "type": "put",
24207     "url": "/api/sms/interactions/{id}",
24208     "title": "Update an existing Interaction",
24209     "examples": [
24210       {
24211         "title": "Example usage:",
24212         "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",
24213         "type": "json"
24214       }
24215     ],
24216     "name": "updateInteractions",
24217     "group": "Sms_Interactions",
24218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24219     "version": "0.0.0",
24220     "filename": "server/api/smsInteraction/index.js",
24221     "groupTitle": "Sms_Interactions"
24222   },
24223   {
24224     "type": "post",
24225     "url": "/api/sms/messages",
24226     "title": "Creates a new Message",
24227     "examples": [
24228       {
24229         "title": "Example usage:",
24230         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24231         "type": "json"
24232       }
24233     ],
24234     "name": "CreateMessages",
24235     "group": "Sms_Messages",
24236     "parameter": {
24237       "fields": {
24238         "Body": [
24239           {
24240             "group": "Body",
24241             "type": "Text",
24242             "optional": false,
24243             "field": "body",
24244             "description": ""
24245           },
24246           {
24247             "group": "Body",
24248             "type": "Boolean",
24249             "optional": true,
24250             "field": "read",
24251             "description": ""
24252           },
24253           {
24254             "group": "Body",
24255             "type": "String",
24256             "allowedValues": [
24257               "\"in\"",
24258               "\"out\""
24259             ],
24260             "optional": false,
24261             "field": "direction",
24262             "description": ""
24263           },
24264           {
24265             "group": "Body",
24266             "type": "String",
24267             "optional": true,
24268             "field": "messageId",
24269             "description": ""
24270           },
24271           {
24272             "group": "Body",
24273             "type": "String",
24274             "optional": true,
24275             "field": "phone",
24276             "description": ""
24277           },
24278           {
24279             "group": "Body",
24280             "type": "String",
24281             "optional": true,
24282             "field": "readAt",
24283             "description": ""
24284           },
24285           {
24286             "group": "Body",
24287             "type": "Boolean",
24288             "optional": true,
24289             "field": "secret",
24290             "description": ""
24291           },
24292           {
24293             "group": "Body",
24294             "type": "String",
24295             "optional": true,
24296             "field": "providerName",
24297             "description": ""
24298           },
24299           {
24300             "group": "Body",
24301             "type": "Text",
24302             "optional": true,
24303             "field": "providerResponse",
24304             "description": ""
24305           }
24306         ]
24307       }
24308     },
24309     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24310     "version": "0.0.0",
24311     "filename": "server/api/smsMessage/index.js",
24312     "groupTitle": "Sms_Messages"
24313   },
24314   {
24315     "type": "delete",
24316     "url": "/api/sms/messages/{id}",
24317     "title": "Deletes a Message",
24318     "examples": [
24319       {
24320         "title": "Example usage:",
24321         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24322         "type": "json"
24323       }
24324     ],
24325     "name": "DeleteMessages",
24326     "group": "Sms_Messages",
24327     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24328     "version": "0.0.0",
24329     "filename": "server/api/smsMessage/index.js",
24330     "groupTitle": "Sms_Messages"
24331   },
24332   {
24333     "type": "get",
24334     "url": "/api/sms/messages/describe",
24335     "title": "Gets table info about Messages",
24336     "examples": [
24337       {
24338         "title": "Example usage:",
24339         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24340         "type": "json"
24341       }
24342     ],
24343     "name": "DescribeMessages",
24344     "group": "Sms_Messages",
24345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24346     "version": "0.0.0",
24347     "filename": "server/api/smsMessage/index.js",
24348     "groupTitle": "Sms_Messages"
24349   },
24350   {
24351     "type": "get",
24352     "url": "/api/sms/messages",
24353     "title": "Gets a list of Messages",
24354     "examples": [
24355       {
24356         "title": "Example usage:",
24357         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24358         "type": "json"
24359       }
24360     ],
24361     "name": "GetMessages",
24362     "group": "Sms_Messages",
24363     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24364     "version": "0.0.0",
24365     "filename": "server/api/smsMessage/index.js",
24366     "groupTitle": "Sms_Messages"
24367   },
24368   {
24369     "type": "get",
24370     "url": "/api/sms/messages/{id}",
24371     "title": "Gets a single Message",
24372     "examples": [
24373       {
24374         "title": "Example usage:",
24375         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24376         "type": "json"
24377       }
24378     ],
24379     "name": "ShowMessages",
24380     "group": "Sms_Messages",
24381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24382     "version": "0.0.0",
24383     "filename": "server/api/smsMessage/index.js",
24384     "groupTitle": "Sms_Messages"
24385   },
24386   {
24387     "type": "put",
24388     "url": "/api/sms/messages/{id}",
24389     "title": "Update an existing Message",
24390     "examples": [
24391       {
24392         "title": "Example usage:",
24393         "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",
24394         "type": "json"
24395       }
24396     ],
24397     "name": "updateMessages",
24398     "group": "Sms_Messages",
24399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24400     "version": "0.0.0",
24401     "filename": "server/api/smsMessage/index.js",
24402     "groupTitle": "Sms_Messages"
24403   },
24404   {
24405     "type": "post",
24406     "url": "/api/sms/reports/queue",
24407     "title": "Creates a new Sms Queue Report",
24408     "examples": [
24409       {
24410         "title": "Example usage:",
24411         "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",
24412         "type": "json"
24413       }
24414     ],
24415     "name": "CreateSms_Queue_Reports",
24416     "group": "Sms_Queue_Reports",
24417     "parameter": {
24418       "fields": {
24419         "Body": [
24420           {
24421             "group": "Body",
24422             "type": "String",
24423             "optional": false,
24424             "field": "uniqueid",
24425             "description": ""
24426           },
24427           {
24428             "group": "Body",
24429             "type": "String",
24430             "optional": true,
24431             "field": "from",
24432             "description": ""
24433           },
24434           {
24435             "group": "Body",
24436             "type": "String",
24437             "optional": true,
24438             "field": "joinAt",
24439             "description": ""
24440           },
24441           {
24442             "group": "Body",
24443             "type": "String",
24444             "optional": true,
24445             "field": "leaveAt",
24446             "description": ""
24447           },
24448           {
24449             "group": "Body",
24450             "type": "String",
24451             "optional": true,
24452             "field": "acceptAt",
24453             "description": ""
24454           },
24455           {
24456             "group": "Body",
24457             "type": "String",
24458             "optional": true,
24459             "field": "exitAt",
24460             "description": ""
24461           },
24462           {
24463             "group": "Body",
24464             "type": "String",
24465             "optional": true,
24466             "field": "reason",
24467             "description": ""
24468           }
24469         ]
24470       }
24471     },
24472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24473     "version": "0.0.0",
24474     "filename": "server/api/smsQueueReport/index.js",
24475     "groupTitle": "Sms_Queue_Reports"
24476   },
24477   {
24478     "type": "delete",
24479     "url": "/api/sms/reports/queue/{id}",
24480     "title": "Deletes a Sms Queue Report",
24481     "examples": [
24482       {
24483         "title": "Example usage:",
24484         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24485         "type": "json"
24486       }
24487     ],
24488     "name": "DeleteSms_Queue_Reports",
24489     "group": "Sms_Queue_Reports",
24490     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24491     "version": "0.0.0",
24492     "filename": "server/api/smsQueueReport/index.js",
24493     "groupTitle": "Sms_Queue_Reports"
24494   },
24495   {
24496     "type": "get",
24497     "url": "/api/sms/reports/queue/describe",
24498     "title": "Gets table info about Sms Queue Reports",
24499     "examples": [
24500       {
24501         "title": "Example usage:",
24502         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24503         "type": "json"
24504       }
24505     ],
24506     "name": "DescribeSms_Queue_Reports",
24507     "group": "Sms_Queue_Reports",
24508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24509     "version": "0.0.0",
24510     "filename": "server/api/smsQueueReport/index.js",
24511     "groupTitle": "Sms_Queue_Reports"
24512   },
24513   {
24514     "type": "get",
24515     "url": "/api/sms/reports/queue",
24516     "title": "Gets a list of Sms Queue Reports",
24517     "examples": [
24518       {
24519         "title": "Example usage:",
24520         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24521         "type": "json"
24522       }
24523     ],
24524     "name": "GetSms_Queue_Reports",
24525     "group": "Sms_Queue_Reports",
24526     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24527     "version": "0.0.0",
24528     "filename": "server/api/smsQueueReport/index.js",
24529     "groupTitle": "Sms_Queue_Reports"
24530   },
24531   {
24532     "type": "get",
24533     "url": "/api/sms/reports/queue/{id}",
24534     "title": "Gets a single Sms Queue Report",
24535     "examples": [
24536       {
24537         "title": "Example usage:",
24538         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24539         "type": "json"
24540       }
24541     ],
24542     "name": "ShowSms_Queue_Reports",
24543     "group": "Sms_Queue_Reports",
24544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24545     "version": "0.0.0",
24546     "filename": "server/api/smsQueueReport/index.js",
24547     "groupTitle": "Sms_Queue_Reports"
24548   },
24549   {
24550     "type": "put",
24551     "url": "/api/sms/reports/queue/{id}",
24552     "title": "Update an existing Sms Queue Report",
24553     "examples": [
24554       {
24555         "title": "Example usage:",
24556         "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",
24557         "type": "json"
24558       }
24559     ],
24560     "name": "updateSms_Queue_Reports",
24561     "group": "Sms_Queue_Reports",
24562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24563     "version": "0.0.0",
24564     "filename": "server/api/smsQueueReport/index.js",
24565     "groupTitle": "Sms_Queue_Reports"
24566   },
24567   {
24568     "type": "post",
24569     "url": "/api/sms/queues/{id}/users",
24570     "title": "Add agents to a queue",
24571     "examples": [
24572       {
24573         "title": "Example usage:",
24574         "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",
24575         "type": "json"
24576       }
24577     ],
24578     "name": "AddAgents",
24579     "group": "Sms_Queues",
24580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24581     "version": "0.0.0",
24582     "filename": "server/api/smsQueue/index.js",
24583     "groupTitle": "Sms_Queues"
24584   },
24585   {
24586     "type": "post",
24587     "url": "/api/sms/queues/{id}/teams",
24588     "title": "Add teams to a queue",
24589     "examples": [
24590       {
24591         "title": "Example usage:",
24592         "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",
24593         "type": "json"
24594       }
24595     ],
24596     "name": "AddTeams",
24597     "group": "Sms_Queues",
24598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24599     "version": "0.0.0",
24600     "filename": "server/api/smsQueue/index.js",
24601     "groupTitle": "Sms_Queues"
24602   },
24603   {
24604     "type": "post",
24605     "url": "/api/sms/queues",
24606     "title": "Creates a new Queue",
24607     "examples": [
24608       {
24609         "title": "Example usage:",
24610         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24611         "type": "json"
24612       }
24613     ],
24614     "name": "CreateQueues",
24615     "group": "Sms_Queues",
24616     "parameter": {
24617       "fields": {
24618         "Body": [
24619           {
24620             "group": "Body",
24621             "type": "String",
24622             "optional": true,
24623             "field": "name",
24624             "description": ""
24625           },
24626           {
24627             "group": "Body",
24628             "type": "String",
24629             "optional": true,
24630             "field": "description",
24631             "description": ""
24632           },
24633           {
24634             "group": "Body",
24635             "type": "Integer",
24636             "optional": true,
24637             "field": "timeout",
24638             "description": ""
24639           },
24640           {
24641             "group": "Body",
24642             "type": "String",
24643             "allowedValues": [
24644               "\"rrmemory\"",
24645               "\"beepall\"",
24646               "\"roundrobin\""
24647             ],
24648             "optional": true,
24649             "field": "strategy",
24650             "description": ""
24651           }
24652         ]
24653       }
24654     },
24655     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24656     "version": "0.0.0",
24657     "filename": "server/api/smsQueue/index.js",
24658     "groupTitle": "Sms_Queues"
24659   },
24660   {
24661     "type": "delete",
24662     "url": "/api/sms/queues/{id}",
24663     "title": "Deletes a Queue",
24664     "examples": [
24665       {
24666         "title": "Example usage:",
24667         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24668         "type": "json"
24669       }
24670     ],
24671     "name": "DeleteQueues",
24672     "group": "Sms_Queues",
24673     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24674     "version": "0.0.0",
24675     "filename": "server/api/smsQueue/index.js",
24676     "groupTitle": "Sms_Queues"
24677   },
24678   {
24679     "type": "get",
24680     "url": "/api/sms/queues/describe",
24681     "title": "Gets table info about Queues",
24682     "examples": [
24683       {
24684         "title": "Example usage:",
24685         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24686         "type": "json"
24687       }
24688     ],
24689     "name": "DescribeQueues",
24690     "group": "Sms_Queues",
24691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24692     "version": "0.0.0",
24693     "filename": "server/api/smsQueue/index.js",
24694     "groupTitle": "Sms_Queues"
24695   },
24696   {
24697     "type": "get",
24698     "url": "/api/sms/queues/{id}/users",
24699     "title": "Gets queue agents",
24700     "examples": [
24701       {
24702         "title": "Example usage:",
24703         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24704         "type": "json"
24705       }
24706     ],
24707     "name": "GetAgents",
24708     "group": "Sms_Queues",
24709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24710     "version": "0.0.0",
24711     "filename": "server/api/smsQueue/index.js",
24712     "groupTitle": "Sms_Queues"
24713   },
24714   {
24715     "type": "get",
24716     "url": "/api/sms/queues/{id}/members",
24717     "title": "GetMembers",
24718     "examples": [
24719       {
24720         "title": "Example usage:",
24721         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24722         "type": "json"
24723       }
24724     ],
24725     "name": "GetMembers",
24726     "group": "Sms_Queues",
24727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24728     "version": "0.0.0",
24729     "filename": "server/api/smsQueue/index.js",
24730     "groupTitle": "Sms_Queues"
24731   },
24732   {
24733     "type": "get",
24734     "url": "/api/sms/queues",
24735     "title": "Gets a list of Queues",
24736     "examples": [
24737       {
24738         "title": "Example usage:",
24739         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24740         "type": "json"
24741       }
24742     ],
24743     "name": "GetQueues",
24744     "group": "Sms_Queues",
24745     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24746     "version": "0.0.0",
24747     "filename": "server/api/smsQueue/index.js",
24748     "groupTitle": "Sms_Queues"
24749   },
24750   {
24751     "type": "get",
24752     "url": "/api/sms/queues/{id}/teams",
24753     "title": "Gets queues list",
24754     "examples": [
24755       {
24756         "title": "Example usage:",
24757         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24758         "type": "json"
24759       }
24760     ],
24761     "name": "GetTeams",
24762     "group": "Sms_Queues",
24763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24764     "version": "0.0.0",
24765     "filename": "server/api/smsQueue/index.js",
24766     "groupTitle": "Sms_Queues"
24767   },
24768   {
24769     "type": "delete",
24770     "url": "/api/sms/queues/{id}/users",
24771     "title": "Removes agents from a queue",
24772     "examples": [
24773       {
24774         "title": "Example usage:",
24775         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24776         "type": "json"
24777       }
24778     ],
24779     "name": "RemoveAgents",
24780     "group": "Sms_Queues",
24781     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24782     "version": "0.0.0",
24783     "filename": "server/api/smsQueue/index.js",
24784     "groupTitle": "Sms_Queues"
24785   },
24786   {
24787     "type": "get",
24788     "url": "/api/sms/queues/{id}",
24789     "title": "Gets a single Queue",
24790     "examples": [
24791       {
24792         "title": "Example usage:",
24793         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24794         "type": "json"
24795       }
24796     ],
24797     "name": "ShowQueues",
24798     "group": "Sms_Queues",
24799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24800     "version": "0.0.0",
24801     "filename": "server/api/smsQueue/index.js",
24802     "groupTitle": "Sms_Queues"
24803   },
24804   {
24805     "type": "put",
24806     "url": "/api/sms/queues/{id}",
24807     "title": "Update an existing Queue",
24808     "examples": [
24809       {
24810         "title": "Example usage:",
24811         "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",
24812         "type": "json"
24813       }
24814     ],
24815     "name": "updateQueues",
24816     "group": "Sms_Queues",
24817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24818     "version": "0.0.0",
24819     "filename": "server/api/smsQueue/index.js",
24820     "groupTitle": "Sms_Queues"
24821   },
24822   {
24823     "type": "post",
24824     "url": "/api/sms/reports/transfer",
24825     "title": "Creates a new Sms Transfer Report",
24826     "examples": [
24827       {
24828         "title": "Example usage:",
24829         "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",
24830         "type": "json"
24831       }
24832     ],
24833     "name": "CreateSms_Transfer_Reports",
24834     "group": "Sms_Transfer_Reports",
24835     "parameter": {
24836       "fields": {
24837         "Body": [
24838           {
24839             "group": "Body",
24840             "type": "String",
24841             "optional": false,
24842             "field": "uniqueid",
24843             "description": ""
24844           },
24845           {
24846             "group": "Body",
24847             "type": "String",
24848             "allowedValues": [
24849               "\"account\"",
24850               "\"agent\"",
24851               "\"queue\""
24852             ],
24853             "optional": false,
24854             "field": "type",
24855             "description": ""
24856           },
24857           {
24858             "group": "Body",
24859             "type": "String",
24860             "optional": false,
24861             "field": "transferredAt",
24862             "description": ""
24863           }
24864         ]
24865       }
24866     },
24867     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24868     "version": "0.0.0",
24869     "filename": "server/api/smsTransferReport/index.js",
24870     "groupTitle": "Sms_Transfer_Reports"
24871   },
24872   {
24873     "type": "delete",
24874     "url": "/api/sms/reports/transfer/{id}",
24875     "title": "Deletes a Sms Transfer Report",
24876     "examples": [
24877       {
24878         "title": "Example usage:",
24879         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24880         "type": "json"
24881       }
24882     ],
24883     "name": "DeleteSms_Transfer_Reports",
24884     "group": "Sms_Transfer_Reports",
24885     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24886     "version": "0.0.0",
24887     "filename": "server/api/smsTransferReport/index.js",
24888     "groupTitle": "Sms_Transfer_Reports"
24889   },
24890   {
24891     "type": "get",
24892     "url": "/api/sms/reports/transfer/describe",
24893     "title": "Gets table info about Sms Transfer Reports",
24894     "examples": [
24895       {
24896         "title": "Example usage:",
24897         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24898         "type": "json"
24899       }
24900     ],
24901     "name": "DescribeSms_Transfer_Reports",
24902     "group": "Sms_Transfer_Reports",
24903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24904     "version": "0.0.0",
24905     "filename": "server/api/smsTransferReport/index.js",
24906     "groupTitle": "Sms_Transfer_Reports"
24907   },
24908   {
24909     "type": "get",
24910     "url": "/api/sms/reports/transfer",
24911     "title": "Gets a list of Sms Transfer Reports",
24912     "examples": [
24913       {
24914         "title": "Example usage:",
24915         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24916         "type": "json"
24917       }
24918     ],
24919     "name": "GetSms_Transfer_Reports",
24920     "group": "Sms_Transfer_Reports",
24921     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24922     "version": "0.0.0",
24923     "filename": "server/api/smsTransferReport/index.js",
24924     "groupTitle": "Sms_Transfer_Reports"
24925   },
24926   {
24927     "type": "get",
24928     "url": "/api/sms/reports/transfer/{id}",
24929     "title": "Gets a single Sms Transfer Report",
24930     "examples": [
24931       {
24932         "title": "Example usage:",
24933         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24934         "type": "json"
24935       }
24936     ],
24937     "name": "ShowSms_Transfer_Reports",
24938     "group": "Sms_Transfer_Reports",
24939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24940     "version": "0.0.0",
24941     "filename": "server/api/smsTransferReport/index.js",
24942     "groupTitle": "Sms_Transfer_Reports"
24943   },
24944   {
24945     "type": "put",
24946     "url": "/api/sms/reports/transfer/{id}",
24947     "title": "Update an existing Sms Transfer Report",
24948     "examples": [
24949       {
24950         "title": "Example usage:",
24951         "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",
24952         "type": "json"
24953       }
24954     ],
24955     "name": "updateSms_Transfer_Reports",
24956     "group": "Sms_Transfer_Reports",
24957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24958     "version": "0.0.0",
24959     "filename": "server/api/smsTransferReport/index.js",
24960     "groupTitle": "Sms_Transfer_Reports"
24961   },
24962   {
24963     "type": "get",
24964     "url": "/api/sounds",
24965     "title": "Gets a list of Sounds",
24966     "examples": [
24967       {
24968         "title": "Example usage:",
24969         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24970         "type": "json"
24971       }
24972     ],
24973     "name": "GetSounds",
24974     "group": "Sounds",
24975     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24976     "version": "0.0.0",
24977     "filename": "server/api/sound/index.js",
24978     "groupTitle": "Sounds"
24979   },
24980   {
24981     "type": "get",
24982     "url": "/api/sounds/{id}",
24983     "title": "Gets a single Sound",
24984     "examples": [
24985       {
24986         "title": "Example usage:",
24987         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24988         "type": "json"
24989       }
24990     ],
24991     "name": "ShowSounds",
24992     "group": "Sounds",
24993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24994     "version": "0.0.0",
24995     "filename": "server/api/sound/index.js",
24996     "groupTitle": "Sounds"
24997   },
24998   {
24999     "type": "post",
25000     "url": "/api/sounds",
25001     "title": "Create a new sound",
25002     "examples": [
25003       {
25004         "title": "Example usage:",
25005         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
25006         "type": "json"
25007       }
25008     ],
25009     "name": "addSound",
25010     "group": "Sounds",
25011     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25012     "version": "0.0.0",
25013     "filename": "server/api/sound/index.js",
25014     "groupTitle": "Sounds"
25015   },
25016   {
25017     "type": "delete",
25018     "url": "/api/sounds/{id}",
25019     "title": "Deletes a sound",
25020     "examples": [
25021       {
25022         "title": "Example usage:",
25023         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
25024         "type": "json"
25025       }
25026     ],
25027     "name": "destroySound",
25028     "group": "Sounds",
25029     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25030     "version": "0.0.0",
25031     "filename": "server/api/sound/index.js",
25032     "groupTitle": "Sounds"
25033   },
25034   {
25035     "type": "get",
25036     "url": "/api/sounds/{id}/download",
25037     "title": "Download Sound",
25038     "examples": [
25039       {
25040         "title": "Example usage:",
25041         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
25042         "type": "json"
25043       }
25044     ],
25045     "name": "download",
25046     "group": "Sounds",
25047     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25048     "version": "0.0.0",
25049     "filename": "server/api/sound/index.js",
25050     "groupTitle": "Sounds"
25051   },
25052   {
25053     "type": "put",
25054     "url": "/api/sounds",
25055     "title": "Update an existing new sound",
25056     "examples": [
25057       {
25058         "title": "Example usage:",
25059         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
25060         "type": "json"
25061       }
25062     ],
25063     "name": "updateSound",
25064     "group": "Sounds",
25065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25066     "version": "0.0.0",
25067     "filename": "server/api/sound/index.js",
25068     "groupTitle": "Sounds"
25069   },
25070   {
25071     "type": "post",
25072     "url": "/api/square/details/reports",
25073     "title": "Creates a new Square Detail Report",
25074     "examples": [
25075       {
25076         "title": "Example usage:",
25077         "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",
25078         "type": "json"
25079       }
25080     ],
25081     "name": "CreateSquare_Detail_Reports",
25082     "group": "Square_Details_Reports",
25083     "parameter": {
25084       "fields": {
25085         "Body": [
25086           {
25087             "group": "Body",
25088             "type": "String",
25089             "optional": true,
25090             "field": "uniqueid",
25091             "description": ""
25092           },
25093           {
25094             "group": "Body",
25095             "type": "String",
25096             "optional": true,
25097             "field": "node",
25098             "description": ""
25099           },
25100           {
25101             "group": "Body",
25102             "type": "String",
25103             "optional": true,
25104             "field": "application",
25105             "description": ""
25106           },
25107           {
25108             "group": "Body",
25109             "type": "Text",
25110             "optional": true,
25111             "field": "data",
25112             "description": ""
25113           },
25114           {
25115             "group": "Body",
25116             "type": "String",
25117             "optional": true,
25118             "field": "project_name",
25119             "description": ""
25120           },
25121           {
25122             "group": "Body",
25123             "type": "String",
25124             "optional": true,
25125             "field": "callerid",
25126             "description": ""
25127           }
25128         ]
25129       }
25130     },
25131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25132     "version": "0.0.0",
25133     "filename": "server/api/squareReportDetail/index.js",
25134     "groupTitle": "Square_Details_Reports"
25135   },
25136   {
25137     "type": "delete",
25138     "url": "/api/square/details/reports/{id}",
25139     "title": "Deletes a Square Detail Report",
25140     "examples": [
25141       {
25142         "title": "Example usage:",
25143         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
25144         "type": "json"
25145       }
25146     ],
25147     "name": "DeleteSquare_Detail_Reports",
25148     "group": "Square_Details_Reports",
25149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25150     "version": "0.0.0",
25151     "filename": "server/api/squareReportDetail/index.js",
25152     "groupTitle": "Square_Details_Reports"
25153   },
25154   {
25155     "type": "get",
25156     "url": "/api/square/details/reports/describe",
25157     "title": "Gets table info about Square Detail Reports",
25158     "examples": [
25159       {
25160         "title": "Example usage:",
25161         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
25162         "type": "json"
25163       }
25164     ],
25165     "name": "DescribeSquare_Detail_Reports",
25166     "group": "Square_Details_Reports",
25167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25168     "version": "0.0.0",
25169     "filename": "server/api/squareReportDetail/index.js",
25170     "groupTitle": "Square_Details_Reports"
25171   },
25172   {
25173     "type": "get",
25174     "url": "/api/square/details/reports",
25175     "title": "Gets a list of Square Detail Reports",
25176     "examples": [
25177       {
25178         "title": "Example usage:",
25179         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
25180         "type": "json"
25181       }
25182     ],
25183     "name": "GetSquare_Detail_Reports",
25184     "group": "Square_Details_Reports",
25185     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25186     "version": "0.0.0",
25187     "filename": "server/api/squareReportDetail/index.js",
25188     "groupTitle": "Square_Details_Reports"
25189   },
25190   {
25191     "type": "get",
25192     "url": "/api/square/details/reports/{id}",
25193     "title": "Gets a single Square Detail Report",
25194     "examples": [
25195       {
25196         "title": "Example usage:",
25197         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
25198         "type": "json"
25199       }
25200     ],
25201     "name": "ShowSquare_Detail_Reports",
25202     "group": "Square_Details_Reports",
25203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25204     "version": "0.0.0",
25205     "filename": "server/api/squareReportDetail/index.js",
25206     "groupTitle": "Square_Details_Reports"
25207   },
25208   {
25209     "type": "put",
25210     "url": "/api/square/details/reports/{id}",
25211     "title": "Update an existing Square Detail Report",
25212     "examples": [
25213       {
25214         "title": "Example usage:",
25215         "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",
25216         "type": "json"
25217       }
25218     ],
25219     "name": "updateSquare_Detail_Reports",
25220     "group": "Square_Details_Reports",
25221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25222     "version": "0.0.0",
25223     "filename": "server/api/squareReportDetail/index.js",
25224     "groupTitle": "Square_Details_Reports"
25225   },
25226   {
25227     "type": "post",
25228     "url": "/api/square/messages",
25229     "title": "Creates a new Message",
25230     "examples": [
25231       {
25232         "title": "Example usage:",
25233         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25234         "type": "json"
25235       }
25236     ],
25237     "name": "CreateMessages",
25238     "group": "Square_Messages",
25239     "parameter": {
25240       "fields": {
25241         "Body": [
25242           {
25243             "group": "Body",
25244             "type": "String",
25245             "optional": true,
25246             "field": "uniqueid",
25247             "description": ""
25248           },
25249           {
25250             "group": "Body",
25251             "type": "Text",
25252             "optional": false,
25253             "field": "body",
25254             "description": ""
25255           },
25256           {
25257             "group": "Body",
25258             "type": "String",
25259             "allowedValues": [
25260               "\"in\"",
25261               "\"out\""
25262             ],
25263             "optional": false,
25264             "field": "direction",
25265             "description": ""
25266           },
25267           {
25268             "group": "Body",
25269             "type": "String",
25270             "optional": true,
25271             "field": "providerName",
25272             "description": ""
25273           },
25274           {
25275             "group": "Body",
25276             "type": "Text",
25277             "optional": true,
25278             "field": "providerResponse",
25279             "description": ""
25280           }
25281         ]
25282       }
25283     },
25284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25285     "version": "0.0.0",
25286     "filename": "server/api/squareMessage/index.js",
25287     "groupTitle": "Square_Messages"
25288   },
25289   {
25290     "type": "delete",
25291     "url": "/api/square/messages/{id}",
25292     "title": "Deletes a Message",
25293     "examples": [
25294       {
25295         "title": "Example usage:",
25296         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
25297         "type": "json"
25298       }
25299     ],
25300     "name": "DeleteMessages",
25301     "group": "Square_Messages",
25302     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25303     "version": "0.0.0",
25304     "filename": "server/api/squareMessage/index.js",
25305     "groupTitle": "Square_Messages"
25306   },
25307   {
25308     "type": "get",
25309     "url": "/api/square/messages",
25310     "title": "Gets a list of Messages",
25311     "examples": [
25312       {
25313         "title": "Example usage:",
25314         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25315         "type": "json"
25316       }
25317     ],
25318     "name": "GetMessages",
25319     "group": "Square_Messages",
25320     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25321     "version": "0.0.0",
25322     "filename": "server/api/squareMessage/index.js",
25323     "groupTitle": "Square_Messages"
25324   },
25325   {
25326     "type": "get",
25327     "url": "/api/square/messages/{id}",
25328     "title": "Gets a single Message",
25329     "examples": [
25330       {
25331         "title": "Example usage:",
25332         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25333         "type": "json"
25334       }
25335     ],
25336     "name": "ShowMessages",
25337     "group": "Square_Messages",
25338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25339     "version": "0.0.0",
25340     "filename": "server/api/squareMessage/index.js",
25341     "groupTitle": "Square_Messages"
25342   },
25343   {
25344     "type": "put",
25345     "url": "/api/square/messages/{id}",
25346     "title": "Update an existing Message",
25347     "examples": [
25348       {
25349         "title": "Example usage:",
25350         "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",
25351         "type": "json"
25352       }
25353     ],
25354     "name": "updateMessages",
25355     "group": "Square_Messages",
25356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25357     "version": "0.0.0",
25358     "filename": "server/api/squareMessage/index.js",
25359     "groupTitle": "Square_Messages"
25360   },
25361   {
25362     "type": "post",
25363     "url": "/api/square/odbc",
25364     "title": "Creates a new ODBC",
25365     "examples": [
25366       {
25367         "title": "Example usage:",
25368         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25369         "type": "json"
25370       }
25371     ],
25372     "name": "CreateODBCs",
25373     "group": "Square_ODBC",
25374     "parameter": {
25375       "fields": {
25376         "Body": [
25377           {
25378             "group": "Body",
25379             "type": "String",
25380             "optional": false,
25381             "field": "name",
25382             "description": ""
25383           },
25384           {
25385             "group": "Body",
25386             "type": "String",
25387             "optional": true,
25388             "field": "dsn",
25389             "description": ""
25390           },
25391           {
25392             "group": "Body",
25393             "type": "String",
25394             "optional": true,
25395             "field": "description",
25396             "description": ""
25397           }
25398         ]
25399       }
25400     },
25401     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25402     "version": "0.0.0",
25403     "filename": "server/api/squareOdbc/index.js",
25404     "groupTitle": "Square_ODBC"
25405   },
25406   {
25407     "type": "delete",
25408     "url": "/api/square/odbc/{id}",
25409     "title": "Deletes a ODBC",
25410     "examples": [
25411       {
25412         "title": "Example usage:",
25413         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25414         "type": "json"
25415       }
25416     ],
25417     "name": "DeleteODBCs",
25418     "group": "Square_ODBC",
25419     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25420     "version": "0.0.0",
25421     "filename": "server/api/squareOdbc/index.js",
25422     "groupTitle": "Square_ODBC"
25423   },
25424   {
25425     "type": "get",
25426     "url": "/api/square/odbc",
25427     "title": "Gets a list of ODBCs",
25428     "examples": [
25429       {
25430         "title": "Example usage:",
25431         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25432         "type": "json"
25433       }
25434     ],
25435     "name": "GetODBCs",
25436     "group": "Square_ODBC",
25437     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25438     "version": "0.0.0",
25439     "filename": "server/api/squareOdbc/index.js",
25440     "groupTitle": "Square_ODBC"
25441   },
25442   {
25443     "type": "get",
25444     "url": "/api/square/odbc/{id}",
25445     "title": "Gets a single ODBC",
25446     "examples": [
25447       {
25448         "title": "Example usage:",
25449         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25450         "type": "json"
25451       }
25452     ],
25453     "name": "ShowODBCs",
25454     "group": "Square_ODBC",
25455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25456     "version": "0.0.0",
25457     "filename": "server/api/squareOdbc/index.js",
25458     "groupTitle": "Square_ODBC"
25459   },
25460   {
25461     "type": "get",
25462     "url": "/api/square/odbc/{id}/test",
25463     "title": "Test Odbc",
25464     "examples": [
25465       {
25466         "title": "Example usage:",
25467         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25468         "type": "json"
25469       }
25470     ],
25471     "name": "test",
25472     "group": "Square_ODBC",
25473     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25474     "version": "0.0.0",
25475     "filename": "server/api/squareOdbc/index.js",
25476     "groupTitle": "Square_ODBC"
25477   },
25478   {
25479     "type": "put",
25480     "url": "/api/square/odbc/{id}",
25481     "title": "Update an existing ODBC",
25482     "examples": [
25483       {
25484         "title": "Example usage:",
25485         "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",
25486         "type": "json"
25487       }
25488     ],
25489     "name": "updateODBCs",
25490     "group": "Square_ODBC",
25491     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25492     "version": "0.0.0",
25493     "filename": "server/api/squareOdbc/index.js",
25494     "groupTitle": "Square_ODBC"
25495   },
25496   {
25497     "type": "post",
25498     "url": "/api/square/projects",
25499     "title": "Creates a new Project",
25500     "examples": [
25501       {
25502         "title": "Example usage:",
25503         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25504         "type": "json"
25505       }
25506     ],
25507     "name": "CreateProjects",
25508     "group": "Square_Projects",
25509     "parameter": {
25510       "fields": {
25511         "Body": [
25512           {
25513             "group": "Body",
25514             "type": "String",
25515             "optional": false,
25516             "field": "name",
25517             "description": ""
25518           },
25519           {
25520             "group": "Body",
25521             "type": "String",
25522             "optional": true,
25523             "field": "description",
25524             "description": ""
25525           },
25526           {
25527             "group": "Body",
25528             "type": "Text",
25529             "optional": true,
25530             "field": "notes",
25531             "description": ""
25532           },
25533           {
25534             "group": "Body",
25535             "type": "Blob",
25536             "optional": true,
25537             "field": "preproduction",
25538             "description": ""
25539           },
25540           {
25541             "group": "Body",
25542             "type": "Blob",
25543             "optional": true,
25544             "field": "production",
25545             "description": ""
25546           },
25547           {
25548             "group": "Body",
25549             "type": "String",
25550             "optional": true,
25551             "field": "savedAt",
25552             "description": ""
25553           },
25554           {
25555             "group": "Body",
25556             "type": "String",
25557             "optional": true,
25558             "field": "publishedAt",
25559             "description": ""
25560           }
25561         ]
25562       }
25563     },
25564     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25565     "version": "0.0.0",
25566     "filename": "server/api/squareProject/index.js",
25567     "groupTitle": "Square_Projects"
25568   },
25569   {
25570     "type": "delete",
25571     "url": "/api/square/projects/{id}",
25572     "title": "Deletes a Project",
25573     "examples": [
25574       {
25575         "title": "Example usage:",
25576         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25577         "type": "json"
25578       }
25579     ],
25580     "name": "DeleteProjects",
25581     "group": "Square_Projects",
25582     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25583     "version": "0.0.0",
25584     "filename": "server/api/squareProject/index.js",
25585     "groupTitle": "Square_Projects"
25586   },
25587   {
25588     "type": "get",
25589     "url": "/api/square/projects",
25590     "title": "Gets a list of Projects",
25591     "examples": [
25592       {
25593         "title": "Example usage:",
25594         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25595         "type": "json"
25596       }
25597     ],
25598     "name": "GetProjects",
25599     "group": "Square_Projects",
25600     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25601     "version": "0.0.0",
25602     "filename": "server/api/squareProject/index.js",
25603     "groupTitle": "Square_Projects"
25604   },
25605   {
25606     "type": "get",
25607     "url": "/api/square/projects/{id}",
25608     "title": "Gets a single Project",
25609     "examples": [
25610       {
25611         "title": "Example usage:",
25612         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25613         "type": "json"
25614       }
25615     ],
25616     "name": "ShowProjects",
25617     "group": "Square_Projects",
25618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25619     "version": "0.0.0",
25620     "filename": "server/api/squareProject/index.js",
25621     "groupTitle": "Square_Projects"
25622   },
25623   {
25624     "type": "put",
25625     "url": "/api/square/projects/{id}",
25626     "title": "Update an existing Project",
25627     "examples": [
25628       {
25629         "title": "Example usage:",
25630         "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",
25631         "type": "json"
25632       }
25633     ],
25634     "name": "updateProjects",
25635     "group": "Square_Projects",
25636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25637     "version": "0.0.0",
25638     "filename": "server/api/squareProject/index.js",
25639     "groupTitle": "Square_Projects"
25640   },
25641   {
25642     "type": "post",
25643     "url": "/api/square/recordings",
25644     "title": "Creates a new Recording",
25645     "examples": [
25646       {
25647         "title": "Example usage:",
25648         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25649         "type": "json"
25650       }
25651     ],
25652     "name": "CreateRecordings",
25653     "group": "Square_Recordings",
25654     "parameter": {
25655       "fields": {
25656         "Body": [
25657           {
25658             "group": "Body",
25659             "type": "String",
25660             "optional": true,
25661             "field": "uniqueid",
25662             "description": ""
25663           },
25664           {
25665             "group": "Body",
25666             "type": "String",
25667             "optional": true,
25668             "field": "callerid",
25669             "description": ""
25670           },
25671           {
25672             "group": "Body",
25673             "type": "String",
25674             "optional": true,
25675             "field": "calleridname",
25676             "description": ""
25677           },
25678           {
25679             "group": "Body",
25680             "type": "String",
25681             "optional": true,
25682             "field": "context",
25683             "description": ""
25684           },
25685           {
25686             "group": "Body",
25687             "type": "String",
25688             "optional": true,
25689             "field": "extension",
25690             "description": ""
25691           },
25692           {
25693             "group": "Body",
25694             "type": "String",
25695             "optional": true,
25696             "field": "priority",
25697             "description": ""
25698           },
25699           {
25700             "group": "Body",
25701             "type": "String",
25702             "optional": true,
25703             "field": "accountcode",
25704             "description": ""
25705           },
25706           {
25707             "group": "Body",
25708             "type": "String",
25709             "optional": true,
25710             "field": "dnid",
25711             "description": ""
25712           },
25713           {
25714             "group": "Body",
25715             "type": "String",
25716             "optional": true,
25717             "field": "projectName",
25718             "description": ""
25719           },
25720           {
25721             "group": "Body",
25722             "type": "String",
25723             "optional": true,
25724             "field": "saveName",
25725             "description": ""
25726           },
25727           {
25728             "group": "Body",
25729             "type": "String",
25730             "optional": true,
25731             "field": "filename",
25732             "description": ""
25733           },
25734           {
25735             "group": "Body",
25736             "type": "String",
25737             "optional": true,
25738             "field": "savePath",
25739             "description": ""
25740           },
25741           {
25742             "group": "Body",
25743             "type": "Virtual",
25744             "optional": true,
25745             "field": "format",
25746             "description": ""
25747           }
25748         ]
25749       }
25750     },
25751     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25752     "version": "0.0.0",
25753     "filename": "server/api/squareRecording/index.js",
25754     "groupTitle": "Square_Recordings"
25755   },
25756   {
25757     "type": "get",
25758     "url": "/api/square/recordings",
25759     "title": "Gets a list of Recordings",
25760     "examples": [
25761       {
25762         "title": "Example usage:",
25763         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25764         "type": "json"
25765       }
25766     ],
25767     "name": "GetRecordings",
25768     "group": "Square_Recordings",
25769     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25770     "version": "0.0.0",
25771     "filename": "server/api/squareRecording/index.js",
25772     "groupTitle": "Square_Recordings"
25773   },
25774   {
25775     "type": "get",
25776     "url": "/api/square/recordings/{id}",
25777     "title": "Gets a single Recording",
25778     "examples": [
25779       {
25780         "title": "Example usage:",
25781         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25782         "type": "json"
25783       }
25784     ],
25785     "name": "ShowRecordings",
25786     "group": "Square_Recordings",
25787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25788     "version": "0.0.0",
25789     "filename": "server/api/squareRecording/index.js",
25790     "groupTitle": "Square_Recordings"
25791   },
25792   {
25793     "type": "delete",
25794     "url": "/api/square/recordings/{id}",
25795     "title": "Delete recording",
25796     "examples": [
25797       {
25798         "title": "Example usage:",
25799         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25800         "type": "json"
25801       }
25802     ],
25803     "name": "destroy",
25804     "group": "Square_Recordings",
25805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25806     "version": "0.0.0",
25807     "filename": "server/api/squareRecording/index.js",
25808     "groupTitle": "Square_Recordings"
25809   },
25810   {
25811     "type": "get",
25812     "url": "/api/square/recordings/{id}/download",
25813     "title": "Download Recording",
25814     "examples": [
25815       {
25816         "title": "Example usage:",
25817         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25818         "type": "json"
25819       }
25820     ],
25821     "name": "download",
25822     "group": "Square_Recordings",
25823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25824     "version": "0.0.0",
25825     "filename": "server/api/squareRecording/index.js",
25826     "groupTitle": "Square_Recordings"
25827   },
25828   {
25829     "type": "put",
25830     "url": "/api/square/recordings/{id}",
25831     "title": "Update an existing Recording",
25832     "examples": [
25833       {
25834         "title": "Example usage:",
25835         "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",
25836         "type": "json"
25837       }
25838     ],
25839     "name": "updateRecordings",
25840     "group": "Square_Recordings",
25841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25842     "version": "0.0.0",
25843     "filename": "server/api/squareRecording/index.js",
25844     "groupTitle": "Square_Recordings"
25845   },
25846   {
25847     "type": "post",
25848     "url": "/api/square/reports",
25849     "title": "Creates a new Square Report",
25850     "examples": [
25851       {
25852         "title": "Example usage:",
25853         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25854         "type": "json"
25855       }
25856     ],
25857     "name": "CreateSquare_Reports",
25858     "group": "Square_Reports",
25859     "parameter": {
25860       "fields": {
25861         "Body": [
25862           {
25863             "group": "Body",
25864             "type": "String",
25865             "optional": true,
25866             "field": "network",
25867             "description": ""
25868           },
25869           {
25870             "group": "Body",
25871             "type": "String",
25872             "optional": true,
25873             "field": "network_script",
25874             "description": ""
25875           },
25876           {
25877             "group": "Body",
25878             "type": "String",
25879             "optional": true,
25880             "field": "request",
25881             "description": ""
25882           },
25883           {
25884             "group": "Body",
25885             "type": "String",
25886             "optional": true,
25887             "field": "channel",
25888             "description": ""
25889           },
25890           {
25891             "group": "Body",
25892             "type": "String",
25893             "optional": true,
25894             "field": "language",
25895             "description": ""
25896           },
25897           {
25898             "group": "Body",
25899             "type": "String",
25900             "optional": true,
25901             "field": "type",
25902             "description": ""
25903           },
25904           {
25905             "group": "Body",
25906             "type": "String",
25907             "optional": true,
25908             "field": "uniqueid",
25909             "description": ""
25910           },
25911           {
25912             "group": "Body",
25913             "type": "String",
25914             "optional": true,
25915             "field": "version",
25916             "description": ""
25917           },
25918           {
25919             "group": "Body",
25920             "type": "String",
25921             "optional": true,
25922             "field": "callerid",
25923             "description": ""
25924           },
25925           {
25926             "group": "Body",
25927             "type": "String",
25928             "optional": true,
25929             "field": "calleridname",
25930             "description": ""
25931           },
25932           {
25933             "group": "Body",
25934             "type": "String",
25935             "optional": true,
25936             "field": "callingpres",
25937             "description": ""
25938           },
25939           {
25940             "group": "Body",
25941             "type": "String",
25942             "optional": true,
25943             "field": "callingani2",
25944             "description": ""
25945           },
25946           {
25947             "group": "Body",
25948             "type": "String",
25949             "optional": true,
25950             "field": "callington",
25951             "description": ""
25952           },
25953           {
25954             "group": "Body",
25955             "type": "String",
25956             "optional": true,
25957             "field": "callingtns",
25958             "description": ""
25959           },
25960           {
25961             "group": "Body",
25962             "type": "String",
25963             "optional": true,
25964             "field": "dnid",
25965             "description": ""
25966           },
25967           {
25968             "group": "Body",
25969             "type": "String",
25970             "optional": true,
25971             "field": "rdnis",
25972             "description": ""
25973           },
25974           {
25975             "group": "Body",
25976             "type": "String",
25977             "optional": true,
25978             "field": "context",
25979             "description": ""
25980           },
25981           {
25982             "group": "Body",
25983             "type": "String",
25984             "optional": true,
25985             "field": "extension",
25986             "description": ""
25987           },
25988           {
25989             "group": "Body",
25990             "type": "String",
25991             "optional": true,
25992             "field": "priority",
25993             "description": ""
25994           },
25995           {
25996             "group": "Body",
25997             "type": "String",
25998             "optional": true,
25999             "field": "enhanced",
26000             "description": ""
26001           },
26002           {
26003             "group": "Body",
26004             "type": "String",
26005             "optional": true,
26006             "field": "accountcode",
26007             "description": ""
26008           },
26009           {
26010             "group": "Body",
26011             "type": "String",
26012             "optional": true,
26013             "field": "threadid",
26014             "description": ""
26015           },
26016           {
26017             "group": "Body",
26018             "type": "String",
26019             "optional": true,
26020             "field": "project_name",
26021             "description": ""
26022           },
26023           {
26024             "group": "Body",
26025             "type": "String",
26026             "optional": true,
26027             "field": "joinAt",
26028             "description": ""
26029           },
26030           {
26031             "group": "Body",
26032             "type": "String",
26033             "optional": true,
26034             "field": "leaveAt",
26035             "description": ""
26036           },
26037           {
26038             "group": "Body",
26039             "type": "Boolean",
26040             "optional": true,
26041             "field": "bot",
26042             "description": ""
26043           }
26044         ]
26045       }
26046     },
26047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26048     "version": "0.0.0",
26049     "filename": "server/api/squareReport/index.js",
26050     "groupTitle": "Square_Reports"
26051   },
26052   {
26053     "type": "delete",
26054     "url": "/api/square/reports/{id}",
26055     "title": "Deletes a Square Report",
26056     "examples": [
26057       {
26058         "title": "Example usage:",
26059         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
26060         "type": "json"
26061       }
26062     ],
26063     "name": "DeleteSquare_Reports",
26064     "group": "Square_Reports",
26065     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066     "version": "0.0.0",
26067     "filename": "server/api/squareReport/index.js",
26068     "groupTitle": "Square_Reports"
26069   },
26070   {
26071     "type": "get",
26072     "url": "/api/square/reports/describe",
26073     "title": "Gets table info about Square Reports",
26074     "examples": [
26075       {
26076         "title": "Example usage:",
26077         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
26078         "type": "json"
26079       }
26080     ],
26081     "name": "DescribeSquare_Reports",
26082     "group": "Square_Reports",
26083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26084     "version": "0.0.0",
26085     "filename": "server/api/squareReport/index.js",
26086     "groupTitle": "Square_Reports"
26087   },
26088   {
26089     "type": "get",
26090     "url": "/api/square/reports",
26091     "title": "Gets a list of Square Reports",
26092     "examples": [
26093       {
26094         "title": "Example usage:",
26095         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
26096         "type": "json"
26097       }
26098     ],
26099     "name": "GetSquare_Reports",
26100     "group": "Square_Reports",
26101     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26102     "version": "0.0.0",
26103     "filename": "server/api/squareReport/index.js",
26104     "groupTitle": "Square_Reports"
26105   },
26106   {
26107     "type": "get",
26108     "url": "/api/square/reports/{id}",
26109     "title": "Gets a single Square Report",
26110     "examples": [
26111       {
26112         "title": "Example usage:",
26113         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
26114         "type": "json"
26115       }
26116     ],
26117     "name": "ShowSquare_Reports",
26118     "group": "Square_Reports",
26119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26120     "version": "0.0.0",
26121     "filename": "server/api/squareReport/index.js",
26122     "groupTitle": "Square_Reports"
26123   },
26124   {
26125     "type": "put",
26126     "url": "/api/square/reports/{id}",
26127     "title": "Update an existing Square Report",
26128     "examples": [
26129       {
26130         "title": "Example usage:",
26131         "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",
26132         "type": "json"
26133       }
26134     ],
26135     "name": "updateSquare_Reports",
26136     "group": "Square_Reports",
26137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26138     "version": "0.0.0",
26139     "filename": "server/api/squareReport/index.js",
26140     "groupTitle": "Square_Reports"
26141   },
26142   {
26143     "type": "post",
26144     "url": "/api/integrations/sugarcrm/configurations",
26145     "title": "Creates a new SugarCRM Configuration",
26146     "examples": [
26147       {
26148         "title": "Example usage:",
26149         "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",
26150         "type": "json"
26151       }
26152     ],
26153     "name": "CreateSugarCRM_Configurations",
26154     "group": "SugarCRM_Configurations",
26155     "parameter": {
26156       "fields": {
26157         "Body": [
26158           {
26159             "group": "Body",
26160             "type": "String",
26161             "optional": true,
26162             "field": "name",
26163             "description": ""
26164           },
26165           {
26166             "group": "Body",
26167             "type": "String",
26168             "optional": true,
26169             "field": "description",
26170             "description": ""
26171           }
26172         ]
26173       }
26174     },
26175     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26176     "version": "0.0.0",
26177     "filename": "server/api/intSugarcrmConfiguration/index.js",
26178     "groupTitle": "SugarCRM_Configurations"
26179   },
26180   {
26181     "type": "delete",
26182     "url": "/api/integrations/sugarcrm/configurations/{id}",
26183     "title": "Deletes a SugarCRM Configuration",
26184     "examples": [
26185       {
26186         "title": "Example usage:",
26187         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
26188         "type": "json"
26189       }
26190     ],
26191     "name": "DeleteSugarCRM_Configurations",
26192     "group": "SugarCRM_Configurations",
26193     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26194     "version": "0.0.0",
26195     "filename": "server/api/intSugarcrmConfiguration/index.js",
26196     "groupTitle": "SugarCRM_Configurations"
26197   },
26198   {
26199     "type": "get",
26200     "url": "/api/integrations/sugarcrm/configurations",
26201     "title": "Gets a list of SugarCRM Configurations",
26202     "examples": [
26203       {
26204         "title": "Example usage:",
26205         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
26206         "type": "json"
26207       }
26208     ],
26209     "name": "GetSugarCRM_Configurations",
26210     "group": "SugarCRM_Configurations",
26211     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26212     "version": "0.0.0",
26213     "filename": "server/api/intSugarcrmConfiguration/index.js",
26214     "groupTitle": "SugarCRM_Configurations"
26215   },
26216   {
26217     "type": "get",
26218     "url": "/api/integrations/sugarcrm/configurations/{id}",
26219     "title": "Gets a single SugarCRM Configuration",
26220     "examples": [
26221       {
26222         "title": "Example usage:",
26223         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
26224         "type": "json"
26225       }
26226     ],
26227     "name": "ShowSugarCRM_Configurations",
26228     "group": "SugarCRM_Configurations",
26229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26230     "version": "0.0.0",
26231     "filename": "server/api/intSugarcrmConfiguration/index.js",
26232     "groupTitle": "SugarCRM_Configurations"
26233   },
26234   {
26235     "type": "put",
26236     "url": "/api/integrations/sugarcrm/configurations/{id}",
26237     "title": "Update an existing SugarCRM Configuration",
26238     "examples": [
26239       {
26240         "title": "Example usage:",
26241         "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",
26242         "type": "json"
26243       }
26244     ],
26245     "name": "updateSugarCRM_Configurations",
26246     "group": "SugarCRM_Configurations",
26247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26248     "version": "0.0.0",
26249     "filename": "server/api/intSugarcrmConfiguration/index.js",
26250     "groupTitle": "SugarCRM_Configurations"
26251   },
26252   {
26253     "type": "post",
26254     "url": "/api/integrations/sugarcrm/accounts",
26255     "title": "Creates a new Sugarcrm Account",
26256     "examples": [
26257       {
26258         "title": "Example usage:",
26259         "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",
26260         "type": "json"
26261       }
26262     ],
26263     "name": "CreateSugarcrm_Accounts",
26264     "group": "Sugarcrm_Accounts",
26265     "parameter": {
26266       "fields": {
26267         "Body": [
26268           {
26269             "group": "Body",
26270             "type": "String",
26271             "optional": true,
26272             "field": "name",
26273             "description": ""
26274           },
26275           {
26276             "group": "Body",
26277             "type": "String",
26278             "optional": true,
26279             "field": "description",
26280             "description": ""
26281           },
26282           {
26283             "group": "Body",
26284             "type": "String",
26285             "optional": true,
26286             "field": "username",
26287             "description": ""
26288           },
26289           {
26290             "group": "Body",
26291             "type": "String",
26292             "optional": true,
26293             "field": "password",
26294             "description": ""
26295           },
26296           {
26297             "group": "Body",
26298             "type": "String",
26299             "optional": true,
26300             "field": "remoteUri",
26301             "description": ""
26302           },
26303           {
26304             "group": "Body",
26305             "type": "String",
26306             "optional": false,
26307             "field": "serverUrl",
26308             "description": ""
26309           }
26310         ]
26311       }
26312     },
26313     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26314     "version": "0.0.0",
26315     "filename": "server/api/intSugarcrmAccount/index.js",
26316     "groupTitle": "Sugarcrm_Accounts"
26317   },
26318   {
26319     "type": "delete",
26320     "url": "/api/integrations/sugarcrm/accounts/{id}",
26321     "title": "Deletes a Sugarcrm Account",
26322     "examples": [
26323       {
26324         "title": "Example usage:",
26325         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26326         "type": "json"
26327       }
26328     ],
26329     "name": "DeleteSugarcrm_Accounts",
26330     "group": "Sugarcrm_Accounts",
26331     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26332     "version": "0.0.0",
26333     "filename": "server/api/intSugarcrmAccount/index.js",
26334     "groupTitle": "Sugarcrm_Accounts"
26335   },
26336   {
26337     "type": "get",
26338     "url": "/api/integrations/sugarcrm/accounts",
26339     "title": "Gets a list of Sugarcrm Accounts",
26340     "examples": [
26341       {
26342         "title": "Example usage:",
26343         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26344         "type": "json"
26345       }
26346     ],
26347     "name": "GetSugarcrm_Accounts",
26348     "group": "Sugarcrm_Accounts",
26349     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26350     "version": "0.0.0",
26351     "filename": "server/api/intSugarcrmAccount/index.js",
26352     "groupTitle": "Sugarcrm_Accounts"
26353   },
26354   {
26355     "type": "get",
26356     "url": "/api/integrations/sugarcrm/accounts/{id}",
26357     "title": "Gets a single Sugarcrm Account",
26358     "examples": [
26359       {
26360         "title": "Example usage:",
26361         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26362         "type": "json"
26363       }
26364     ],
26365     "name": "ShowSugarcrm_Accounts",
26366     "group": "Sugarcrm_Accounts",
26367     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26368     "version": "0.0.0",
26369     "filename": "server/api/intSugarcrmAccount/index.js",
26370     "groupTitle": "Sugarcrm_Accounts"
26371   },
26372   {
26373     "type": "post",
26374     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26375     "title": "Creates new configuration",
26376     "examples": [
26377       {
26378         "title": "Example usage:",
26379         "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",
26380         "type": "json"
26381       }
26382     ],
26383     "name": "addConfiguration",
26384     "group": "Sugarcrm_Accounts",
26385     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26386     "version": "0.0.0",
26387     "filename": "server/api/intSugarcrmAccount/index.js",
26388     "groupTitle": "Sugarcrm_Accounts"
26389   },
26390   {
26391     "type": "get",
26392     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26393     "title": "Gets account configurations",
26394     "examples": [
26395       {
26396         "title": "Example usage:",
26397         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26398         "type": "json"
26399       }
26400     ],
26401     "name": "getConfigurations",
26402     "group": "Sugarcrm_Accounts",
26403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26404     "version": "0.0.0",
26405     "filename": "server/api/intSugarcrmAccount/index.js",
26406     "groupTitle": "Sugarcrm_Accounts"
26407   },
26408   {
26409     "type": "get",
26410     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26411     "title": "Gets account fields",
26412     "examples": [
26413       {
26414         "title": "Example usage:",
26415         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26416         "type": "json"
26417       }
26418     ],
26419     "name": "getFields",
26420     "group": "Sugarcrm_Accounts",
26421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26422     "version": "0.0.0",
26423     "filename": "server/api/intSugarcrmAccount/index.js",
26424     "groupTitle": "Sugarcrm_Accounts"
26425   },
26426   {
26427     "type": "put",
26428     "url": "/api/integrations/sugarcrm/accounts/{id}",
26429     "title": "Update an existing Sugarcrm Account",
26430     "examples": [
26431       {
26432         "title": "Example usage:",
26433         "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",
26434         "type": "json"
26435       }
26436     ],
26437     "name": "updateSugarcrm_Accounts",
26438     "group": "Sugarcrm_Accounts",
26439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26440     "version": "0.0.0",
26441     "filename": "server/api/intSugarcrmAccount/index.js",
26442     "groupTitle": "Sugarcrm_Accounts"
26443   },
26444   {
26445     "type": "get",
26446     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26447     "title": "Gets configurations descriptions",
26448     "examples": [
26449       {
26450         "title": "Example usage:",
26451         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26452         "type": "json"
26453       }
26454     ],
26455     "name": "getDescriptions",
26456     "group": "Sugarcrm_Configurations",
26457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26458     "version": "0.0.0",
26459     "filename": "server/api/intSugarcrmConfiguration/index.js",
26460     "groupTitle": "Sugarcrm_Configurations"
26461   },
26462   {
26463     "type": "get",
26464     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26465     "title": "Gets configurations fields",
26466     "examples": [
26467       {
26468         "title": "Example usage:",
26469         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26470         "type": "json"
26471       }
26472     ],
26473     "name": "getFields",
26474     "group": "Sugarcrm_Configurations",
26475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26476     "version": "0.0.0",
26477     "filename": "server/api/intSugarcrmConfiguration/index.js",
26478     "groupTitle": "Sugarcrm_Configurations"
26479   },
26480   {
26481     "type": "get",
26482     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26483     "title": "Gets configurations subjects",
26484     "examples": [
26485       {
26486         "title": "Example usage:",
26487         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26488         "type": "json"
26489       }
26490     ],
26491     "name": "getSubjects",
26492     "group": "Sugarcrm_Configurations",
26493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26494     "version": "0.0.0",
26495     "filename": "server/api/intSugarcrmConfiguration/index.js",
26496     "groupTitle": "Sugarcrm_Configurations"
26497   },
26498   {
26499     "type": "post",
26500     "url": "/api/integrations/sugarcrm/fields",
26501     "title": "Creates a new Sugarcrm Field",
26502     "examples": [
26503       {
26504         "title": "Example usage:",
26505         "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",
26506         "type": "json"
26507       }
26508     ],
26509     "name": "CreateSugarcrm_Fields",
26510     "group": "Sugarcrm_Fields",
26511     "parameter": {
26512       "fields": {
26513         "Body": [
26514           {
26515             "group": "Body",
26516             "type": "String",
26517             "allowedValues": [
26518               "\"string\"",
26519               "\"variable\"",
26520               "\"customVariable\"",
26521               "\"keyValue\"",
26522               "\"picklist\""
26523             ],
26524             "optional": true,
26525             "field": "type",
26526             "description": ""
26527           },
26528           {
26529             "group": "Body",
26530             "type": "String",
26531             "optional": true,
26532             "field": "content",
26533             "description": ""
26534           },
26535           {
26536             "group": "Body",
26537             "type": "String",
26538             "optional": true,
26539             "field": "key",
26540             "description": ""
26541           },
26542           {
26543             "group": "Body",
26544             "type": "String",
26545             "allowedValues": [
26546               "\"string\"",
26547               "\"variable\"",
26548               "\"customVariable\""
26549             ],
26550             "optional": true,
26551             "field": "keyType",
26552             "description": ""
26553           },
26554           {
26555             "group": "Body",
26556             "type": "String",
26557             "optional": true,
26558             "field": "keyContent",
26559             "description": ""
26560           },
26561           {
26562             "group": "Body",
26563             "type": "String",
26564             "optional": true,
26565             "field": "idField",
26566             "description": ""
26567           },
26568           {
26569             "group": "Body",
26570             "type": "String",
26571             "optional": true,
26572             "field": "nameField",
26573             "description": ""
26574           },
26575           {
26576             "group": "Body",
26577             "type": "Boolean",
26578             "optional": true,
26579             "field": "customField",
26580             "description": ""
26581           },
26582           {
26583             "group": "Body",
26584             "type": "String",
26585             "optional": true,
26586             "field": "variableName",
26587             "description": ""
26588           }
26589         ]
26590       }
26591     },
26592     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26593     "version": "0.0.0",
26594     "filename": "server/api/intSugarcrmField/index.js",
26595     "groupTitle": "Sugarcrm_Fields"
26596   },
26597   {
26598     "type": "delete",
26599     "url": "/api/integrations/sugarcrm/fields/{id}",
26600     "title": "Deletes a Sugarcrm Field",
26601     "examples": [
26602       {
26603         "title": "Example usage:",
26604         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26605         "type": "json"
26606       }
26607     ],
26608     "name": "DeleteSugarcrm_Fields",
26609     "group": "Sugarcrm_Fields",
26610     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26611     "version": "0.0.0",
26612     "filename": "server/api/intSugarcrmField/index.js",
26613     "groupTitle": "Sugarcrm_Fields"
26614   },
26615   {
26616     "type": "get",
26617     "url": "/api/integrations/sugarcrm/fields",
26618     "title": "Gets a list of Sugarcrm Fields",
26619     "examples": [
26620       {
26621         "title": "Example usage:",
26622         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26623         "type": "json"
26624       }
26625     ],
26626     "name": "GetSugarcrm_Fields",
26627     "group": "Sugarcrm_Fields",
26628     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26629     "version": "0.0.0",
26630     "filename": "server/api/intSugarcrmField/index.js",
26631     "groupTitle": "Sugarcrm_Fields"
26632   },
26633   {
26634     "type": "get",
26635     "url": "/api/integrations/sugarcrm/fields/{id}",
26636     "title": "Gets a single Sugarcrm Field",
26637     "examples": [
26638       {
26639         "title": "Example usage:",
26640         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26641         "type": "json"
26642       }
26643     ],
26644     "name": "ShowSugarcrm_Fields",
26645     "group": "Sugarcrm_Fields",
26646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26647     "version": "0.0.0",
26648     "filename": "server/api/intSugarcrmField/index.js",
26649     "groupTitle": "Sugarcrm_Fields"
26650   },
26651   {
26652     "type": "put",
26653     "url": "/api/integrations/sugarcrm/fields/{id}",
26654     "title": "Update an existing Sugarcrm Field",
26655     "examples": [
26656       {
26657         "title": "Example usage:",
26658         "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",
26659         "type": "json"
26660       }
26661     ],
26662     "name": "updateSugarcrm_Fields",
26663     "group": "Sugarcrm_Fields",
26664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26665     "version": "0.0.0",
26666     "filename": "server/api/intSugarcrmField/index.js",
26667     "groupTitle": "Sugarcrm_Fields"
26668   },
26669   {
26670     "type": "get",
26671     "url": "/api/system",
26672     "title": "Gets system information",
26673     "examples": [
26674       {
26675         "title": "Example usage:",
26676         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26677         "type": "json"
26678       }
26679     ],
26680     "name": "GetSystemInformation",
26681     "group": "System_Information",
26682     "description": "<p>Motion returns the system information.</p>",
26683     "version": "0.0.0",
26684     "filename": "server/api/system/index.js",
26685     "groupTitle": "System_Information"
26686   },
26687   {
26688     "type": "get",
26689     "url": "/api/system/process",
26690     "title": "Gets system information",
26691     "examples": [
26692       {
26693         "title": "Example usage:",
26694         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26695         "type": "json"
26696       }
26697     ],
26698     "name": "GetSystemInformation",
26699     "group": "System_Information",
26700     "description": "<p>Motion returns the system information.</p>",
26701     "version": "0.0.0",
26702     "filename": "server/api/system/index.js",
26703     "groupTitle": "System_Information"
26704   },
26705   {
26706     "type": "post",
26707     "url": "/api/tags",
26708     "title": "Creates a new Tag",
26709     "examples": [
26710       {
26711         "title": "Example usage:",
26712         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26713         "type": "json"
26714       }
26715     ],
26716     "name": "CreateTags",
26717     "group": "Tags",
26718     "parameter": {
26719       "fields": {
26720         "Body": [
26721           {
26722             "group": "Body",
26723             "type": "String",
26724             "optional": false,
26725             "field": "name",
26726             "description": ""
26727           },
26728           {
26729             "group": "Body",
26730             "type": "String",
26731             "optional": true,
26732             "field": "color",
26733             "description": ""
26734           },
26735           {
26736             "group": "Body",
26737             "type": "String",
26738             "optional": true,
26739             "field": "description",
26740             "description": ""
26741           }
26742         ]
26743       }
26744     },
26745     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26746     "version": "0.0.0",
26747     "filename": "server/api/tag/index.js",
26748     "groupTitle": "Tags"
26749   },
26750   {
26751     "type": "delete",
26752     "url": "/api/tags/{id}",
26753     "title": "Deletes a Tag",
26754     "examples": [
26755       {
26756         "title": "Example usage:",
26757         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26758         "type": "json"
26759       }
26760     ],
26761     "name": "DeleteTags",
26762     "group": "Tags",
26763     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26764     "version": "0.0.0",
26765     "filename": "server/api/tag/index.js",
26766     "groupTitle": "Tags"
26767   },
26768   {
26769     "type": "get",
26770     "url": "/api/tags/describe",
26771     "title": "Gets table info about Accounts",
26772     "examples": [
26773       {
26774         "title": "Example usage:",
26775         "content": "curl https://{domain}/api/tags/describe -v -u {name}:{password}",
26776         "type": "json"
26777       }
26778     ],
26779     "name": "DescribeTags",
26780     "group": "Tags",
26781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26782     "version": "0.0.0",
26783     "filename": "server/api/tag/index.js",
26784     "groupTitle": "Tags"
26785   },
26786   {
26787     "type": "get",
26788     "url": "/api/tags",
26789     "title": "Gets a list of Tags",
26790     "examples": [
26791       {
26792         "title": "Example usage:",
26793         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26794         "type": "json"
26795       }
26796     ],
26797     "name": "GetTags",
26798     "group": "Tags",
26799     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26800     "version": "0.0.0",
26801     "filename": "server/api/tag/index.js",
26802     "groupTitle": "Tags"
26803   },
26804   {
26805     "type": "get",
26806     "url": "/api/tags/{id}",
26807     "title": "Gets a single Tag",
26808     "examples": [
26809       {
26810         "title": "Example usage:",
26811         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26812         "type": "json"
26813       }
26814     ],
26815     "name": "ShowTags",
26816     "group": "Tags",
26817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26818     "version": "0.0.0",
26819     "filename": "server/api/tag/index.js",
26820     "groupTitle": "Tags"
26821   },
26822   {
26823     "type": "put",
26824     "url": "/api/tags/{id}",
26825     "title": "Update an existing Tag",
26826     "examples": [
26827       {
26828         "title": "Example usage:",
26829         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26830         "type": "json"
26831       }
26832     ],
26833     "name": "updateTags",
26834     "group": "Tags",
26835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26836     "version": "0.0.0",
26837     "filename": "server/api/tag/index.js",
26838     "groupTitle": "Tags"
26839   },
26840   {
26841     "type": "post",
26842     "url": "/api/teams/{id}/queues",
26843     "title": "Add queues to a team",
26844     "examples": [
26845       {
26846         "title": "Example usage:",
26847         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26848         "type": "json"
26849       }
26850     ],
26851     "name": "AddQueues",
26852     "group": "Teams",
26853     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26854     "version": "0.0.0",
26855     "filename": "server/api/team/index.js",
26856     "groupTitle": "Teams"
26857   },
26858   {
26859     "type": "post",
26860     "url": "/api/teams",
26861     "title": "Creates a new Team",
26862     "examples": [
26863       {
26864         "title": "Example usage:",
26865         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26866         "type": "json"
26867       }
26868     ],
26869     "name": "CreateTeams",
26870     "group": "Teams",
26871     "parameter": {
26872       "fields": {
26873         "Body": [
26874           {
26875             "group": "Body",
26876             "type": "String",
26877             "optional": false,
26878             "field": "name",
26879             "description": ""
26880           },
26881           {
26882             "group": "Body",
26883             "type": "String",
26884             "optional": true,
26885             "field": "description",
26886             "description": ""
26887           }
26888         ]
26889       }
26890     },
26891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26892     "version": "0.0.0",
26893     "filename": "server/api/team/index.js",
26894     "groupTitle": "Teams"
26895   },
26896   {
26897     "type": "delete",
26898     "url": "/api/teams/{id}",
26899     "title": "Deletes a Team",
26900     "examples": [
26901       {
26902         "title": "Example usage:",
26903         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26904         "type": "json"
26905       }
26906     ],
26907     "name": "DeleteTeams",
26908     "group": "Teams",
26909     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26910     "version": "0.0.0",
26911     "filename": "server/api/team/index.js",
26912     "groupTitle": "Teams"
26913   },
26914   {
26915     "type": "get",
26916     "url": "/api/teams/{id}/users",
26917     "title": "Gets agents from team",
26918     "examples": [
26919       {
26920         "title": "Example usage:",
26921         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26922         "type": "json"
26923       }
26924     ],
26925     "name": "GetAgents",
26926     "group": "Teams",
26927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26928     "version": "0.0.0",
26929     "filename": "server/api/team/index.js",
26930     "groupTitle": "Teams"
26931   },
26932   {
26933     "type": "get",
26934     "url": "/api/teams/{id}/queues?channel={channel}",
26935     "title": "Gets Queues list",
26936     "examples": [
26937       {
26938         "title": "Example usage:",
26939         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26940         "type": "json"
26941       }
26942     ],
26943     "name": "GetQueues",
26944     "group": "Teams",
26945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26946     "version": "0.0.0",
26947     "filename": "server/api/team/index.js",
26948     "groupTitle": "Teams"
26949   },
26950   {
26951     "type": "get",
26952     "url": "/api/teams",
26953     "title": "Gets a list of Teams",
26954     "examples": [
26955       {
26956         "title": "Example usage:",
26957         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26958         "type": "json"
26959       }
26960     ],
26961     "name": "GetTeams",
26962     "group": "Teams",
26963     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26964     "version": "0.0.0",
26965     "filename": "server/api/team/index.js",
26966     "groupTitle": "Teams"
26967   },
26968   {
26969     "type": "delete",
26970     "url": "/api/teams/{id}/users",
26971     "title": "Removes agents from a team",
26972     "examples": [
26973       {
26974         "title": "Example usage:",
26975         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26976         "type": "json"
26977       }
26978     ],
26979     "name": "RemoveAgents",
26980     "group": "Teams",
26981     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26982     "version": "0.0.0",
26983     "filename": "server/api/team/index.js",
26984     "groupTitle": "Teams"
26985   },
26986   {
26987     "type": "delete",
26988     "url": "/api/teams/{id}/queues",
26989     "title": "Remove queues to a team",
26990     "examples": [
26991       {
26992         "title": "Example usage:",
26993         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26994         "type": "json"
26995       }
26996     ],
26997     "name": "RemoveQueues",
26998     "group": "Teams",
26999     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27000     "version": "0.0.0",
27001     "filename": "server/api/team/index.js",
27002     "groupTitle": "Teams"
27003   },
27004   {
27005     "type": "delete",
27006     "url": "/api/whatsapp/queues/{id}/teams",
27007     "title": "Remove teams from a queue",
27008     "examples": [
27009       {
27010         "title": "Example usage:",
27011         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27012         "type": "json"
27013       }
27014     ],
27015     "name": "RemoveTeams",
27016     "group": "Teams",
27017     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27018     "version": "0.0.0",
27019     "filename": "server/api/whatsappQueue/index.js",
27020     "groupTitle": "Teams"
27021   },
27022   {
27023     "type": "delete",
27024     "url": "/api/voice/queues/{id}/teams",
27025     "title": "Remove teams from a queue",
27026     "examples": [
27027       {
27028         "title": "Example usage:",
27029         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27030         "type": "json"
27031       }
27032     ],
27033     "name": "RemoveTeams",
27034     "group": "Teams",
27035     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27036     "version": "0.0.0",
27037     "filename": "server/api/voiceQueue/index.js",
27038     "groupTitle": "Teams"
27039   },
27040   {
27041     "type": "delete",
27042     "url": "/api/sms/queues/{id}/teams",
27043     "title": "Remove teams from a queue",
27044     "examples": [
27045       {
27046         "title": "Example usage:",
27047         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27048         "type": "json"
27049       }
27050     ],
27051     "name": "RemoveTeams",
27052     "group": "Teams",
27053     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27054     "version": "0.0.0",
27055     "filename": "server/api/smsQueue/index.js",
27056     "groupTitle": "Teams"
27057   },
27058   {
27059     "type": "delete",
27060     "url": "/api/voice/Prefixes/{id}/teams",
27061     "title": "Remove teams from a voice prefix",
27062     "examples": [
27063       {
27064         "title": "Example usage:",
27065         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
27066         "type": "json"
27067       }
27068     ],
27069     "name": "RemoveTeams",
27070     "group": "Teams",
27071     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27072     "version": "0.0.0",
27073     "filename": "server/api/voicePrefix/index.js",
27074     "groupTitle": "Teams"
27075   },
27076   {
27077     "type": "delete",
27078     "url": "/api/chat/queues/{id}/teams",
27079     "title": "Remove teams from a queue",
27080     "examples": [
27081       {
27082         "title": "Example usage:",
27083         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27084         "type": "json"
27085       }
27086     ],
27087     "name": "RemoveTeams",
27088     "group": "Teams",
27089     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27090     "version": "0.0.0",
27091     "filename": "server/api/chatQueue/index.js",
27092     "groupTitle": "Teams"
27093   },
27094   {
27095     "type": "delete",
27096     "url": "/api/mail/queues/{id}/teams",
27097     "title": "Remove teams from a queue",
27098     "examples": [
27099       {
27100         "title": "Example usage:",
27101         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27102         "type": "json"
27103       }
27104     ],
27105     "name": "RemoveTeams",
27106     "group": "Teams",
27107     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27108     "version": "0.0.0",
27109     "filename": "server/api/mailQueue/index.js",
27110     "groupTitle": "Teams"
27111   },
27112   {
27113     "type": "delete",
27114     "url": "/api/fax/queues/{id}/teams",
27115     "title": "Remove teams from a queue",
27116     "examples": [
27117       {
27118         "title": "Example usage:",
27119         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27120         "type": "json"
27121       }
27122     ],
27123     "name": "RemoveTeams",
27124     "group": "Teams",
27125     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27126     "version": "0.0.0",
27127     "filename": "server/api/faxQueue/index.js",
27128     "groupTitle": "Teams"
27129   },
27130   {
27131     "type": "delete",
27132     "url": "/api/openchannel/queues/{id}/teams",
27133     "title": "Remove teams from a queue",
27134     "examples": [
27135       {
27136         "title": "Example usage:",
27137         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27138         "type": "json"
27139       }
27140     ],
27141     "name": "RemoveTeams",
27142     "group": "Teams",
27143     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27144     "version": "0.0.0",
27145     "filename": "server/api/openchannelQueue/index.js",
27146     "groupTitle": "Teams"
27147   },
27148   {
27149     "type": "get",
27150     "url": "/api/teams/{id}",
27151     "title": "Gets a single Team",
27152     "examples": [
27153       {
27154         "title": "Example usage:",
27155         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
27156         "type": "json"
27157       }
27158     ],
27159     "name": "ShowTeams",
27160     "group": "Teams",
27161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27162     "version": "0.0.0",
27163     "filename": "server/api/team/index.js",
27164     "groupTitle": "Teams"
27165   },
27166   {
27167     "type": "post",
27168     "url": "/api/teams/{id}/users",
27169     "title": "Adds agents to a team",
27170     "examples": [
27171       {
27172         "title": "Example usage:",
27173         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27174         "type": "json"
27175       }
27176     ],
27177     "name": "addAgents",
27178     "group": "Teams",
27179     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27180     "version": "0.0.0",
27181     "filename": "server/api/team/index.js",
27182     "groupTitle": "Teams"
27183   },
27184   {
27185     "type": "put",
27186     "url": "/api/teams/{id}",
27187     "title": "Update an existing Team",
27188     "examples": [
27189       {
27190         "title": "Example usage:",
27191         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27192         "type": "json"
27193       }
27194     ],
27195     "name": "updateTeams",
27196     "group": "Teams",
27197     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27198     "version": "0.0.0",
27199     "filename": "server/api/team/index.js",
27200     "groupTitle": "Teams"
27201   },
27202   {
27203     "type": "post",
27204     "url": "/api/templates",
27205     "title": "Creates a new Template",
27206     "examples": [
27207       {
27208         "title": "Example usage:",
27209         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27210         "type": "json"
27211       }
27212     ],
27213     "name": "CreateTemplates",
27214     "group": "Templates",
27215     "parameter": {
27216       "fields": {
27217         "Body": [
27218           {
27219             "group": "Body",
27220             "type": "String",
27221             "optional": true,
27222             "field": "name",
27223             "description": ""
27224           },
27225           {
27226             "group": "Body",
27227             "type": "String",
27228             "optional": true,
27229             "field": "description",
27230             "description": ""
27231           },
27232           {
27233             "group": "Body",
27234             "type": "Text",
27235             "optional": true,
27236             "field": "html",
27237             "description": ""
27238           }
27239         ]
27240       }
27241     },
27242     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27243     "version": "0.0.0",
27244     "filename": "server/api/template/index.js",
27245     "groupTitle": "Templates"
27246   },
27247   {
27248     "type": "delete",
27249     "url": "/api/templates/{id}",
27250     "title": "Deletes a Template",
27251     "examples": [
27252       {
27253         "title": "Example usage:",
27254         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
27255         "type": "json"
27256       }
27257     ],
27258     "name": "DeleteTemplates",
27259     "group": "Templates",
27260     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27261     "version": "0.0.0",
27262     "filename": "server/api/template/index.js",
27263     "groupTitle": "Templates"
27264   },
27265   {
27266     "type": "get",
27267     "url": "/api/templates",
27268     "title": "Gets a list of Templates",
27269     "examples": [
27270       {
27271         "title": "Example usage:",
27272         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
27273         "type": "json"
27274       }
27275     ],
27276     "name": "GetTemplates",
27277     "group": "Templates",
27278     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27279     "version": "0.0.0",
27280     "filename": "server/api/template/index.js",
27281     "groupTitle": "Templates"
27282   },
27283   {
27284     "type": "get",
27285     "url": "/api/templates/{id}",
27286     "title": "Gets a single Template",
27287     "examples": [
27288       {
27289         "title": "Example usage:",
27290         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
27291         "type": "json"
27292       }
27293     ],
27294     "name": "ShowTemplates",
27295     "group": "Templates",
27296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27297     "version": "0.0.0",
27298     "filename": "server/api/template/index.js",
27299     "groupTitle": "Templates"
27300   },
27301   {
27302     "type": "put",
27303     "url": "/api/templates/{id}",
27304     "title": "Update an existing Template",
27305     "examples": [
27306       {
27307         "title": "Example usage:",
27308         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27309         "type": "json"
27310       }
27311     ],
27312     "name": "updateTemplates",
27313     "group": "Templates",
27314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27315     "version": "0.0.0",
27316     "filename": "server/api/template/index.js",
27317     "groupTitle": "Templates"
27318   },
27319   {
27320     "type": "post",
27321     "url": "/api/triggers",
27322     "title": "Creates a new Trigger",
27323     "examples": [
27324       {
27325         "title": "Example usage:",
27326         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27327         "type": "json"
27328       }
27329     ],
27330     "name": "CreateTriggers",
27331     "group": "Triggers",
27332     "parameter": {
27333       "fields": {
27334         "Body": [
27335           {
27336             "group": "Body",
27337             "type": "String",
27338             "optional": true,
27339             "field": "name",
27340             "description": ""
27341           },
27342           {
27343             "group": "Body",
27344             "type": "String",
27345             "optional": true,
27346             "field": "channel",
27347             "description": ""
27348           },
27349           {
27350             "group": "Body",
27351             "type": "String",
27352             "optional": true,
27353             "field": "description",
27354             "description": ""
27355           },
27356           {
27357             "group": "Body",
27358             "type": "Boolean",
27359             "optional": true,
27360             "field": "status",
27361             "description": ""
27362           }
27363         ]
27364       }
27365     },
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/trigger/index.js",
27369     "groupTitle": "Triggers"
27370   },
27371   {
27372     "type": "delete",
27373     "url": "/api/triggers/{id}",
27374     "title": "Deletes a Trigger",
27375     "examples": [
27376       {
27377         "title": "Example usage:",
27378         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27379         "type": "json"
27380       }
27381     ],
27382     "name": "DeleteTriggers",
27383     "group": "Triggers",
27384     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27385     "version": "0.0.0",
27386     "filename": "server/api/trigger/index.js",
27387     "groupTitle": "Triggers"
27388   },
27389   {
27390     "type": "get",
27391     "url": "/api/triggers",
27392     "title": "Gets a list of Triggers",
27393     "examples": [
27394       {
27395         "title": "Example usage:",
27396         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27397         "type": "json"
27398       }
27399     ],
27400     "name": "GetTriggers",
27401     "group": "Triggers",
27402     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27403     "version": "0.0.0",
27404     "filename": "server/api/trigger/index.js",
27405     "groupTitle": "Triggers"
27406   },
27407   {
27408     "type": "get",
27409     "url": "/api/triggers/{id}",
27410     "title": "Gets a single Trigger",
27411     "examples": [
27412       {
27413         "title": "Example usage:",
27414         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27415         "type": "json"
27416       }
27417     ],
27418     "name": "ShowTriggers",
27419     "group": "Triggers",
27420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27421     "version": "0.0.0",
27422     "filename": "server/api/trigger/index.js",
27423     "groupTitle": "Triggers"
27424   },
27425   {
27426     "type": "post",
27427     "url": "/api/triggers/{id}/actions",
27428     "title": "Creates new actions",
27429     "examples": [
27430       {
27431         "title": "Example usage:",
27432         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27433         "type": "json"
27434       }
27435     ],
27436     "name": "addAction",
27437     "group": "Triggers",
27438     "parameter": {
27439       "fields": {
27440         "Body": [
27441           {
27442             "group": "Body",
27443             "type": "Virtual",
27444             "optional": true,
27445             "field": "name",
27446             "description": ""
27447           },
27448           {
27449             "group": "Body",
27450             "type": "String",
27451             "optional": false,
27452             "field": "action",
27453             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27454           },
27455           {
27456             "group": "Body",
27457             "type": "String",
27458             "optional": true,
27459             "field": "data1",
27460             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27461           },
27462           {
27463             "group": "Body",
27464             "type": "String",
27465             "optional": true,
27466             "field": "data2",
27467             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27468           },
27469           {
27470             "group": "Body",
27471             "type": "String",
27472             "optional": true,
27473             "field": "data3",
27474             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27475           },
27476           {
27477             "group": "Body",
27478             "type": "String",
27479             "optional": true,
27480             "field": "data4",
27481             "description": ""
27482           },
27483           {
27484             "group": "Body",
27485             "type": "String",
27486             "optional": true,
27487             "field": "data5",
27488             "description": ""
27489           },
27490           {
27491             "group": "Body",
27492             "type": "String",
27493             "optional": true,
27494             "field": "data6",
27495             "description": ""
27496           },
27497           {
27498             "group": "Body",
27499             "type": "Text",
27500             "optional": true,
27501             "field": "data7",
27502             "description": ""
27503           }
27504         ]
27505       }
27506     },
27507     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27508     "version": "0.0.0",
27509     "filename": "server/api/trigger/index.js",
27510     "groupTitle": "Triggers"
27511   },
27512   {
27513     "type": "post",
27514     "url": "/api/triggers/{id}/all_conditions",
27515     "title": "Creates a new \"AND\"condition",
27516     "examples": [
27517       {
27518         "title": "Example usage:",
27519         "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",
27520         "type": "json"
27521       }
27522     ],
27523     "name": "addAllCondition",
27524     "group": "Triggers",
27525     "parameter": {
27526       "fields": {
27527         "Body": [
27528           {
27529             "group": "Body",
27530             "type": "Virtual",
27531             "optional": true,
27532             "field": "name",
27533             "description": ""
27534           },
27535           {
27536             "group": "Body",
27537             "type": "String",
27538             "optional": false,
27539             "field": "field",
27540             "description": ""
27541           },
27542           {
27543             "group": "Body",
27544             "type": "String",
27545             "optional": false,
27546             "field": "operator",
27547             "description": ""
27548           },
27549           {
27550             "group": "Body",
27551             "type": "String",
27552             "optional": false,
27553             "field": "value",
27554             "description": ""
27555           }
27556         ]
27557       }
27558     },
27559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27560     "version": "0.0.0",
27561     "filename": "server/api/trigger/index.js",
27562     "groupTitle": "Triggers"
27563   },
27564   {
27565     "type": "post",
27566     "url": "/api/triggers/{id}/any_conditions",
27567     "title": "Creates a new \"OR\"condition",
27568     "examples": [
27569       {
27570         "title": "Example usage:",
27571         "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",
27572         "type": "json"
27573       }
27574     ],
27575     "name": "addAnyCondition",
27576     "group": "Triggers",
27577     "parameter": {
27578       "fields": {
27579         "Body": [
27580           {
27581             "group": "Body",
27582             "type": "Virtual",
27583             "optional": true,
27584             "field": "name",
27585             "description": ""
27586           },
27587           {
27588             "group": "Body",
27589             "type": "String",
27590             "optional": false,
27591             "field": "field",
27592             "description": ""
27593           },
27594           {
27595             "group": "Body",
27596             "type": "String",
27597             "optional": false,
27598             "field": "operator",
27599             "description": ""
27600           },
27601           {
27602             "group": "Body",
27603             "type": "String",
27604             "optional": false,
27605             "field": "value",
27606             "description": ""
27607           }
27608         ]
27609       }
27610     },
27611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27612     "version": "0.0.0",
27613     "filename": "server/api/trigger/index.js",
27614     "groupTitle": "Triggers"
27615   },
27616   {
27617     "type": "get",
27618     "url": "/api/triggers/{id}/actions",
27619     "title": "Gets Trigger Actions",
27620     "examples": [
27621       {
27622         "title": "Example usage:",
27623         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27624         "type": "json"
27625       }
27626     ],
27627     "name": "getActions",
27628     "group": "Triggers",
27629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27630     "version": "0.0.0",
27631     "filename": "server/api/trigger/index.js",
27632     "groupTitle": "Triggers"
27633   },
27634   {
27635     "type": "get",
27636     "url": "/api/triggers/{id}/all_conditions",
27637     "title": "Gets \"AND\" Trigger Conditions",
27638     "examples": [
27639       {
27640         "title": "Example usage:",
27641         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27642         "type": "json"
27643       }
27644     ],
27645     "name": "getAllConditions",
27646     "group": "Triggers",
27647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27648     "version": "0.0.0",
27649     "filename": "server/api/trigger/index.js",
27650     "groupTitle": "Triggers"
27651   },
27652   {
27653     "type": "get",
27654     "url": "/api/triggers/{id}/any_conditions",
27655     "title": "Gets \"OR\" Trigger Conditions",
27656     "examples": [
27657       {
27658         "title": "Example usage:",
27659         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27660         "type": "json"
27661       }
27662     ],
27663     "name": "getAnyConditions",
27664     "group": "Triggers",
27665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27666     "version": "0.0.0",
27667     "filename": "server/api/trigger/index.js",
27668     "groupTitle": "Triggers"
27669   },
27670   {
27671     "type": "put",
27672     "url": "/api/triggers/{id}",
27673     "title": "Update an existing Trigger",
27674     "examples": [
27675       {
27676         "title": "Example usage:",
27677         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27678         "type": "json"
27679       }
27680     ],
27681     "name": "updateTriggers",
27682     "group": "Triggers",
27683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27684     "version": "0.0.0",
27685     "filename": "server/api/trigger/index.js",
27686     "groupTitle": "Triggers"
27687   },
27688   {
27689     "type": "post",
27690     "url": "/api/trunks/clone",
27691     "title": "Clone an existing Trunk",
27692     "examples": [
27693       {
27694         "title": "Example usage:",
27695         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27696         "type": "json"
27697       }
27698     ],
27699     "name": "CloneTrunks",
27700     "group": "Trunks",
27701     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27702     "version": "0.0.0",
27703     "filename": "server/api/trunk/index.js",
27704     "groupTitle": "Trunks"
27705   },
27706   {
27707     "type": "post",
27708     "url": "/api/trunks",
27709     "title": "Create a new trunk",
27710     "examples": [
27711       {
27712         "title": "Example usage:",
27713         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27714         "type": "json"
27715       }
27716     ],
27717     "name": "Create",
27718     "group": "Trunks",
27719     "parameter": {
27720       "fields": {
27721         "Body": [
27722           {
27723             "group": "Body",
27724             "type": "String",
27725             "optional": false,
27726             "field": "name",
27727             "description": ""
27728           },
27729           {
27730             "group": "Body",
27731             "type": "String",
27732             "allowedValues": [
27733               "\"friend\"",
27734               "\"user\"",
27735               "\"peer\""
27736             ],
27737             "optional": false,
27738             "field": "type",
27739             "description": ""
27740           },
27741           {
27742             "group": "Body",
27743             "type": "String",
27744             "optional": false,
27745             "field": "context",
27746             "description": ""
27747           },
27748           {
27749             "group": "Body",
27750             "type": "String",
27751             "allowedValues": [
27752               "\"ALLOWED_NOT_SCREENED\"",
27753               "\"ALLOWED_PASSED_SCREEN\"",
27754               "\"ALLOWED_FAILED_SCREEN\"",
27755               "\"ALLOWED\"",
27756               "\"PROHIB_NOT_SCREENED\"",
27757               "\"PROHIB_PASSED_SCREEN\"",
27758               "\"PROHIB_FAILED_SCREEN\"",
27759               "\"PROHIB\""
27760             ],
27761             "optional": true,
27762             "field": "callingpres",
27763             "description": ""
27764           },
27765           {
27766             "group": "Body",
27767             "type": "String",
27768             "optional": true,
27769             "field": "deny",
27770             "description": ""
27771           },
27772           {
27773             "group": "Body",
27774             "type": "String",
27775             "optional": true,
27776             "field": "permit",
27777             "description": ""
27778           },
27779           {
27780             "group": "Body",
27781             "type": "String",
27782             "optional": true,
27783             "field": "secret",
27784             "description": ""
27785           },
27786           {
27787             "group": "Body",
27788             "type": "String",
27789             "optional": true,
27790             "field": "md5secret",
27791             "description": ""
27792           },
27793           {
27794             "group": "Body",
27795             "type": "String",
27796             "optional": true,
27797             "field": "remotesecret",
27798             "description": ""
27799           },
27800           {
27801             "group": "Body",
27802             "type": "String",
27803             "optional": true,
27804             "field": "transport",
27805             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27806           },
27807           {
27808             "group": "Body",
27809             "type": "String",
27810             "allowedValues": [
27811               "\"rfc2833\"",
27812               "\"info\"",
27813               "\"shortinfo\"",
27814               "\"inband\"",
27815               "\"auto\""
27816             ],
27817             "optional": true,
27818             "field": "dtmfmode",
27819             "description": ""
27820           },
27821           {
27822             "group": "Body",
27823             "type": "String",
27824             "allowedValues": [
27825               "\"yes\"",
27826               "\"no\"",
27827               "\"nonat\"",
27828               "\"update\"",
27829               "\"outgoing\""
27830             ],
27831             "optional": true,
27832             "field": "directmedia",
27833             "description": ""
27834           },
27835           {
27836             "group": "Body",
27837             "type": "String",
27838             "allowedValues": [
27839               "\"yes\"",
27840               "\"no\""
27841             ],
27842             "optional": true,
27843             "field": "directrtpsetup",
27844             "description": ""
27845           },
27846           {
27847             "group": "Body",
27848             "type": "String",
27849             "optional": true,
27850             "field": "directmediapermit",
27851             "description": ""
27852           },
27853           {
27854             "group": "Body",
27855             "type": "String",
27856             "optional": true,
27857             "field": "directmediadeny",
27858             "description": ""
27859           },
27860           {
27861             "group": "Body",
27862             "type": "String",
27863             "optional": true,
27864             "field": "nat",
27865             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27866           },
27867           {
27868             "group": "Body",
27869             "type": "String",
27870             "optional": true,
27871             "field": "callgroup",
27872             "description": ""
27873           },
27874           {
27875             "group": "Body",
27876             "type": "String",
27877             "optional": true,
27878             "field": "namedcallgroup",
27879             "description": ""
27880           },
27881           {
27882             "group": "Body",
27883             "type": "String",
27884             "optional": true,
27885             "field": "pickupgroup",
27886             "description": ""
27887           },
27888           {
27889             "group": "Body",
27890             "type": "String",
27891             "optional": true,
27892             "field": "namedpickupgroup",
27893             "description": ""
27894           },
27895           {
27896             "group": "Body",
27897             "type": "String",
27898             "optional": true,
27899             "field": "language",
27900             "description": ""
27901           },
27902           {
27903             "group": "Body",
27904             "type": "String",
27905             "optional": true,
27906             "field": "tonezone",
27907             "description": ""
27908           },
27909           {
27910             "group": "Body",
27911             "type": "String",
27912             "optional": true,
27913             "field": "disallow",
27914             "description": ""
27915           },
27916           {
27917             "group": "Body",
27918             "type": "String",
27919             "optional": false,
27920             "field": "allow",
27921             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27922           },
27923           {
27924             "group": "Body",
27925             "type": "String",
27926             "allowedValues": [
27927               "\"yes\"",
27928               "\"no\""
27929             ],
27930             "optional": true,
27931             "field": "autoframing",
27932             "description": ""
27933           },
27934           {
27935             "group": "Body",
27936             "type": "String",
27937             "optional": true,
27938             "field": "insecure",
27939             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27940           },
27941           {
27942             "group": "Body",
27943             "type": "String",
27944             "allowedValues": [
27945               "\"yes\"",
27946               "\"no\""
27947             ],
27948             "optional": true,
27949             "field": "trustrpid",
27950             "description": ""
27951           },
27952           {
27953             "group": "Body",
27954             "type": "String",
27955             "allowedValues": [
27956               "\"yes\"",
27957               "\"no\""
27958             ],
27959             "optional": true,
27960             "field": "trust_id_outbound",
27961             "description": ""
27962           },
27963           {
27964             "group": "Body",
27965             "type": "String",
27966             "allowedValues": [
27967               "\"yes\"",
27968               "\"no\"",
27969               "\"never\""
27970             ],
27971             "optional": true,
27972             "field": "progressinband",
27973             "description": ""
27974           },
27975           {
27976             "group": "Body",
27977             "type": "String",
27978             "allowedValues": [
27979               "\"yes\"",
27980               "\"no\""
27981             ],
27982             "optional": true,
27983             "field": "promiscredir",
27984             "description": ""
27985           },
27986           {
27987             "group": "Body",
27988             "type": "String",
27989             "allowedValues": [
27990               "\"yes\"",
27991               "\"no\""
27992             ],
27993             "optional": true,
27994             "field": "useclientcode",
27995             "description": ""
27996           },
27997           {
27998             "group": "Body",
27999             "type": "Integer",
28000             "optional": true,
28001             "field": "accountcode",
28002             "description": ""
28003           },
28004           {
28005             "group": "Body",
28006             "type": "String",
28007             "optional": true,
28008             "field": "setvar",
28009             "description": ""
28010           },
28011           {
28012             "group": "Body",
28013             "type": "String",
28014             "optional": true,
28015             "field": "callerid",
28016             "description": ""
28017           },
28018           {
28019             "group": "Body",
28020             "type": "String",
28021             "optional": true,
28022             "field": "amaflags",
28023             "description": ""
28024           },
28025           {
28026             "group": "Body",
28027             "type": "String",
28028             "allowedValues": [
28029               "\"yes\"",
28030               "\"no\""
28031             ],
28032             "optional": true,
28033             "field": "callcounter",
28034             "description": ""
28035           },
28036           {
28037             "group": "Body",
28038             "type": "Integer",
28039             "optional": true,
28040             "field": "busylevel",
28041             "description": ""
28042           },
28043           {
28044             "group": "Body",
28045             "type": "String",
28046             "allowedValues": [
28047               "\"yes\"",
28048               "\"no\""
28049             ],
28050             "optional": true,
28051             "field": "allowoverlap",
28052             "description": ""
28053           },
28054           {
28055             "group": "Body",
28056             "type": "String",
28057             "allowedValues": [
28058               "\"yes\"",
28059               "\"no\""
28060             ],
28061             "optional": true,
28062             "field": "allowsubscribe",
28063             "description": ""
28064           },
28065           {
28066             "group": "Body",
28067             "type": "String",
28068             "allowedValues": [
28069               "\"yes\"",
28070               "\"no\""
28071             ],
28072             "optional": true,
28073             "field": "allowtransfer",
28074             "description": ""
28075           },
28076           {
28077             "group": "Body",
28078             "type": "String",
28079             "allowedValues": [
28080               "\"yes\"",
28081               "\"no\""
28082             ],
28083             "optional": true,
28084             "field": "ignoresdpversion",
28085             "description": ""
28086           },
28087           {
28088             "group": "Body",
28089             "type": "String",
28090             "optional": true,
28091             "field": "subscribecontext",
28092             "description": ""
28093           },
28094           {
28095             "group": "Body",
28096             "type": "String",
28097             "optional": true,
28098             "field": "template",
28099             "description": ""
28100           },
28101           {
28102             "group": "Body",
28103             "type": "String",
28104             "allowedValues": [
28105               "\"yes\"",
28106               "\"no\"",
28107               "\"always\""
28108             ],
28109             "optional": true,
28110             "field": "videosupport",
28111             "description": ""
28112           },
28113           {
28114             "group": "Body",
28115             "type": "Integer",
28116             "optional": true,
28117             "field": "maxcallbitrate",
28118             "description": ""
28119           },
28120           {
28121             "group": "Body",
28122             "type": "String",
28123             "allowedValues": [
28124               "\"yes\"",
28125               "\"no\""
28126             ],
28127             "optional": true,
28128             "field": "rfc2833compensate",
28129             "description": ""
28130           },
28131           {
28132             "group": "Body",
28133             "type": "String",
28134             "optional": true,
28135             "field": "mailbox",
28136             "description": ""
28137           },
28138           {
28139             "group": "Body",
28140             "type": "String",
28141             "allowedValues": [
28142               "\"accept\"",
28143               "\"refuse\"",
28144               "\"originate\""
28145             ],
28146             "optional": true,
28147             "field": "session_timers",
28148             "description": ""
28149           },
28150           {
28151             "group": "Body",
28152             "type": "Integer",
28153             "optional": true,
28154             "field": "session_expires",
28155             "description": ""
28156           },
28157           {
28158             "group": "Body",
28159             "type": "Integer",
28160             "optional": true,
28161             "field": "session_minse",
28162             "description": ""
28163           },
28164           {
28165             "group": "Body",
28166             "type": "String",
28167             "allowedValues": [
28168               "\"uac\"",
28169               "\"uas\""
28170             ],
28171             "optional": true,
28172             "field": "session_refresher",
28173             "description": ""
28174           },
28175           {
28176             "group": "Body",
28177             "type": "String",
28178             "optional": true,
28179             "field": "t38pt_usertpsource",
28180             "description": ""
28181           },
28182           {
28183             "group": "Body",
28184             "type": "String",
28185             "optional": true,
28186             "field": "regexten",
28187             "description": ""
28188           },
28189           {
28190             "group": "Body",
28191             "type": "String",
28192             "optional": true,
28193             "field": "fromdomain",
28194             "description": ""
28195           },
28196           {
28197             "group": "Body",
28198             "type": "String",
28199             "optional": true,
28200             "field": "fromuser",
28201             "description": ""
28202           },
28203           {
28204             "group": "Body",
28205             "type": "Integer",
28206             "optional": true,
28207             "field": "port",
28208             "description": ""
28209           },
28210           {
28211             "group": "Body",
28212             "type": "String",
28213             "allowedValues": [
28214               "\"yes\"",
28215               "\"no\""
28216             ],
28217             "optional": true,
28218             "field": "qualify",
28219             "description": ""
28220           },
28221           {
28222             "group": "Body",
28223             "type": "Integer",
28224             "optional": true,
28225             "field": "keepalive",
28226             "description": ""
28227           },
28228           {
28229             "group": "Body",
28230             "type": "String",
28231             "optional": true,
28232             "field": "defaultip",
28233             "description": ""
28234           },
28235           {
28236             "group": "Body",
28237             "type": "String",
28238             "optional": true,
28239             "field": "defaultuser",
28240             "description": ""
28241           },
28242           {
28243             "group": "Body",
28244             "type": "Integer",
28245             "optional": true,
28246             "field": "rtptimeout",
28247             "description": ""
28248           },
28249           {
28250             "group": "Body",
28251             "type": "Integer",
28252             "optional": true,
28253             "field": "rtpholdtimeout",
28254             "description": ""
28255           },
28256           {
28257             "group": "Body",
28258             "type": "Integer",
28259             "optional": true,
28260             "field": "rtpkeepalive",
28261             "description": ""
28262           },
28263           {
28264             "group": "Body",
28265             "type": "String",
28266             "allowedValues": [
28267               "\"yes\"",
28268               "\"no\"",
28269               "\"pai\""
28270             ],
28271             "optional": true,
28272             "field": "sendrpid",
28273             "description": ""
28274           },
28275           {
28276             "group": "Body",
28277             "type": "String",
28278             "optional": true,
28279             "field": "outboundproxy",
28280             "description": ""
28281           },
28282           {
28283             "group": "Body",
28284             "type": "String",
28285             "optional": true,
28286             "field": "callbackextension",
28287             "description": ""
28288           },
28289           {
28290             "group": "Body",
28291             "type": "Integer",
28292             "optional": true,
28293             "field": "timert1",
28294             "description": ""
28295           },
28296           {
28297             "group": "Body",
28298             "type": "Integer",
28299             "optional": true,
28300             "field": "timerb",
28301             "description": ""
28302           },
28303           {
28304             "group": "Body",
28305             "type": "Integer",
28306             "optional": true,
28307             "field": "qualifyfreq",
28308             "description": ""
28309           },
28310           {
28311             "group": "Body",
28312             "type": "String",
28313             "optional": true,
28314             "field": "contactpermit",
28315             "description": ""
28316           },
28317           {
28318             "group": "Body",
28319             "type": "String",
28320             "optional": true,
28321             "field": "contactdeny",
28322             "description": ""
28323           },
28324           {
28325             "group": "Body",
28326             "type": "String",
28327             "optional": true,
28328             "field": "contactacl",
28329             "description": ""
28330           },
28331           {
28332             "group": "Body",
28333             "type": "String",
28334             "optional": true,
28335             "field": "unsolicited_mailbox",
28336             "description": ""
28337           },
28338           {
28339             "group": "Body",
28340             "type": "String",
28341             "optional": true,
28342             "field": "use_q850_reason",
28343             "description": ""
28344           },
28345           {
28346             "group": "Body",
28347             "type": "Integer",
28348             "optional": true,
28349             "field": "maxforwards",
28350             "description": ""
28351           },
28352           {
28353             "group": "Body",
28354             "type": "String",
28355             "allowedValues": [
28356               "\"yes\"",
28357               "\"no\""
28358             ],
28359             "optional": true,
28360             "field": "encryption",
28361             "description": ""
28362           },
28363           {
28364             "group": "Body",
28365             "type": "String",
28366             "allowedValues": [
28367               "\"yes\"",
28368               "\"no\""
28369             ],
28370             "optional": true,
28371             "field": "avpf",
28372             "description": ""
28373           },
28374           {
28375             "group": "Body",
28376             "type": "String",
28377             "allowedValues": [
28378               "\"yes\"",
28379               "\"no\""
28380             ],
28381             "optional": true,
28382             "field": "force_avp",
28383             "description": ""
28384           },
28385           {
28386             "group": "Body",
28387             "type": "String",
28388             "allowedValues": [
28389               "\"yes\"",
28390               "\"no\""
28391             ],
28392             "optional": true,
28393             "field": "icesupport",
28394             "description": ""
28395           },
28396           {
28397             "group": "Body",
28398             "type": "String",
28399             "allowedValues": [
28400               "\"yes\"",
28401               "\"no\""
28402             ],
28403             "optional": true,
28404             "field": "dtlsenable",
28405             "description": ""
28406           },
28407           {
28408             "group": "Body",
28409             "type": "String",
28410             "allowedValues": [
28411               "\"yes\"",
28412               "\"no\"",
28413               "\"fingerprint\"",
28414               "\"certificate\""
28415             ],
28416             "optional": true,
28417             "field": "dtlsverify",
28418             "description": ""
28419           },
28420           {
28421             "group": "Body",
28422             "type": "Integer",
28423             "optional": true,
28424             "field": "dtlsrekey",
28425             "description": ""
28426           },
28427           {
28428             "group": "Body",
28429             "type": "String",
28430             "optional": true,
28431             "field": "dtlscertfile",
28432             "description": ""
28433           },
28434           {
28435             "group": "Body",
28436             "type": "String",
28437             "optional": true,
28438             "field": "dtlsprivatekey",
28439             "description": ""
28440           },
28441           {
28442             "group": "Body",
28443             "type": "String",
28444             "optional": true,
28445             "field": "dtlscipher",
28446             "description": ""
28447           },
28448           {
28449             "group": "Body",
28450             "type": "String",
28451             "optional": true,
28452             "field": "dtlscafile",
28453             "description": ""
28454           },
28455           {
28456             "group": "Body",
28457             "type": "String",
28458             "optional": true,
28459             "field": "dtlscapath",
28460             "description": ""
28461           },
28462           {
28463             "group": "Body",
28464             "type": "String",
28465             "allowedValues": [
28466               "\"active\"",
28467               "\"passive\"",
28468               "\"actpass\""
28469             ],
28470             "optional": true,
28471             "field": "dtlssetup",
28472             "description": ""
28473           },
28474           {
28475             "group": "Body",
28476             "type": "String",
28477             "optional": true,
28478             "field": "dtlsfingerprint",
28479             "description": ""
28480           },
28481           {
28482             "group": "Body",
28483             "type": "String",
28484             "allowedValues": [
28485               "\"yes\"",
28486               "\"no\""
28487             ],
28488             "optional": true,
28489             "field": "usereqphone",
28490             "description": ""
28491           },
28492           {
28493             "group": "Body",
28494             "type": "String",
28495             "optional": true,
28496             "field": "recordonfeature",
28497             "description": ""
28498           },
28499           {
28500             "group": "Body",
28501             "type": "String",
28502             "optional": true,
28503             "field": "recordofffeature",
28504             "description": ""
28505           },
28506           {
28507             "group": "Body",
28508             "type": "Integer",
28509             "optional": true,
28510             "field": "call_limit",
28511             "description": ""
28512           },
28513           {
28514             "group": "Body",
28515             "type": "String",
28516             "allowedValues": [
28517               "\"yes\"",
28518               "\"no\""
28519             ],
28520             "optional": true,
28521             "field": "registertrying",
28522             "description": ""
28523           },
28524           {
28525             "group": "Body",
28526             "type": "String",
28527             "allowedValues": [
28528               "\"yes\"",
28529               "\"no\""
28530             ],
28531             "optional": true,
28532             "field": "subscribemwi",
28533             "description": ""
28534           },
28535           {
28536             "group": "Body",
28537             "type": "String",
28538             "optional": true,
28539             "field": "vmexten",
28540             "description": ""
28541           },
28542           {
28543             "group": "Body",
28544             "type": "String",
28545             "optional": true,
28546             "field": "mohinterpret",
28547             "description": ""
28548           },
28549           {
28550             "group": "Body",
28551             "type": "String",
28552             "optional": true,
28553             "field": "mohsuggest",
28554             "description": ""
28555           },
28556           {
28557             "group": "Body",
28558             "type": "String",
28559             "optional": true,
28560             "field": "parkinglot",
28561             "description": ""
28562           },
28563           {
28564             "group": "Body",
28565             "type": "String",
28566             "optional": true,
28567             "field": "description",
28568             "description": ""
28569           },
28570           {
28571             "group": "Body",
28572             "type": "String",
28573             "optional": true,
28574             "field": "host",
28575             "description": ""
28576           },
28577           {
28578             "group": "Body",
28579             "type": "String",
28580             "allowedValues": [
28581               "\"yes\"",
28582               "\"no\"",
28583               "\"nonat\"",
28584               "\"update\"",
28585               "\"update,nonat\""
28586             ],
28587             "optional": true,
28588             "field": "canreinvite",
28589             "description": ""
28590           },
28591           {
28592             "group": "Body",
28593             "type": "String",
28594             "optional": true,
28595             "field": "registry",
28596             "description": ""
28597           },
28598           {
28599             "group": "Body",
28600             "type": "String",
28601             "optional": true,
28602             "field": "otherFields",
28603             "description": ""
28604           },
28605           {
28606             "group": "Body",
28607             "type": "Boolean",
28608             "optional": false,
28609             "field": "active",
28610             "description": ""
28611           },
28612           {
28613             "group": "Body",
28614             "type": "String",
28615             "optional": true,
28616             "field": "t38pt_udptl",
28617             "description": ""
28618           }
28619         ]
28620       }
28621     },
28622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28623     "version": "0.0.0",
28624     "filename": "server/api/trunk/index.js",
28625     "groupTitle": "Trunks"
28626   },
28627   {
28628     "type": "delete",
28629     "url": "/api/trunks/{id}",
28630     "title": "Deletes a trunk",
28631     "examples": [
28632       {
28633         "title": "Example usage:",
28634         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28635         "type": "json"
28636       }
28637     ],
28638     "name": "Delete",
28639     "group": "Trunks",
28640     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28641     "version": "0.0.0",
28642     "filename": "server/api/trunk/index.js",
28643     "groupTitle": "Trunks"
28644   },
28645   {
28646     "type": "get",
28647     "url": "/api/trunks",
28648     "title": "Gets a list of Trunks",
28649     "examples": [
28650       {
28651         "title": "Example usage:",
28652         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28653         "type": "json"
28654       }
28655     ],
28656     "name": "GetTrunks",
28657     "group": "Trunks",
28658     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28659     "version": "0.0.0",
28660     "filename": "server/api/trunk/index.js",
28661     "groupTitle": "Trunks"
28662   },
28663   {
28664     "type": "get",
28665     "url": "/api/trunks/{id}",
28666     "title": "Gets a single Trunk",
28667     "examples": [
28668       {
28669         "title": "Example usage:",
28670         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28671         "type": "json"
28672       }
28673     ],
28674     "name": "ShowTrunks",
28675     "group": "Trunks",
28676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28677     "version": "0.0.0",
28678     "filename": "server/api/trunk/index.js",
28679     "groupTitle": "Trunks"
28680   },
28681   {
28682     "type": "put",
28683     "url": "/api/trunks/{id}",
28684     "title": "Update an existing trunk",
28685     "examples": [
28686       {
28687         "title": "Example usage:",
28688         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28689         "type": "json"
28690       }
28691     ],
28692     "name": "Update",
28693     "group": "Trunks",
28694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28695     "version": "0.0.0",
28696     "filename": "server/api/trunk/index.js",
28697     "groupTitle": "Trunks"
28698   },
28699   {
28700     "type": "post",
28701     "url": "/api/userNotifications",
28702     "title": "Send notification to user",
28703     "examples": [
28704       {
28705         "title": "Example usage:",
28706         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28707         "type": "json"
28708       }
28709     ],
28710     "name": "Send",
28711     "group": "UserNotifications",
28712     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28713     "version": "0.0.0",
28714     "filename": "server/api/userNotification/index.js",
28715     "groupTitle": "UserNotifications"
28716   },
28717   {
28718     "type": "post",
28719     "url": "/api/userProfile/resources",
28720     "title": "Creates a new User Profile Resource",
28721     "examples": [
28722       {
28723         "title": "Example usage:",
28724         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28725         "type": "json"
28726       }
28727     ],
28728     "name": "CreateUser_Profile_Resources",
28729     "group": "User_Profile_Resources",
28730     "parameter": {
28731       "fields": {
28732         "Body": [
28733           {
28734             "group": "Body",
28735             "type": "String",
28736             "optional": false,
28737             "field": "name",
28738             "description": ""
28739           },
28740           {
28741             "group": "Body",
28742             "type": "Integer",
28743             "optional": false,
28744             "field": "resourceId",
28745             "description": ""
28746           },
28747           {
28748             "group": "Body",
28749             "type": "String",
28750             "optional": false,
28751             "field": "type",
28752             "description": ""
28753           }
28754         ]
28755       }
28756     },
28757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28758     "version": "0.0.0",
28759     "filename": "server/api/userProfileResource/index.js",
28760     "groupTitle": "User_Profile_Resources"
28761   },
28762   {
28763     "type": "delete",
28764     "url": "/api/userProfile/resources/{id}",
28765     "title": "Deletes a User Profile Resource",
28766     "examples": [
28767       {
28768         "title": "Example usage:",
28769         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28770         "type": "json"
28771       }
28772     ],
28773     "name": "DeleteUser_Profile_Resources",
28774     "group": "User_Profile_Resources",
28775     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28776     "version": "0.0.0",
28777     "filename": "server/api/userProfileResource/index.js",
28778     "groupTitle": "User_Profile_Resources"
28779   },
28780   {
28781     "type": "get",
28782     "url": "/api/userProfile/resources/describe",
28783     "title": "Gets table info about User Profile Resources",
28784     "examples": [
28785       {
28786         "title": "Example usage:",
28787         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28788         "type": "json"
28789       }
28790     ],
28791     "name": "DescribeUser_Profile_Resources",
28792     "group": "User_Profile_Resources",
28793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28794     "version": "0.0.0",
28795     "filename": "server/api/userProfileResource/index.js",
28796     "groupTitle": "User_Profile_Resources"
28797   },
28798   {
28799     "type": "get",
28800     "url": "/api/userProfile/resources",
28801     "title": "Gets a list of User Profile Resources",
28802     "examples": [
28803       {
28804         "title": "Example usage:",
28805         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28806         "type": "json"
28807       }
28808     ],
28809     "name": "GetUser_Profile_Resources",
28810     "group": "User_Profile_Resources",
28811     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28812     "version": "0.0.0",
28813     "filename": "server/api/userProfileResource/index.js",
28814     "groupTitle": "User_Profile_Resources"
28815   },
28816   {
28817     "type": "get",
28818     "url": "/api/userProfile/resources/{id}",
28819     "title": "Gets a single User Profile Resource",
28820     "examples": [
28821       {
28822         "title": "Example usage:",
28823         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28824         "type": "json"
28825       }
28826     ],
28827     "name": "ShowUser_Profile_Resources",
28828     "group": "User_Profile_Resources",
28829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28830     "version": "0.0.0",
28831     "filename": "server/api/userProfileResource/index.js",
28832     "groupTitle": "User_Profile_Resources"
28833   },
28834   {
28835     "type": "put",
28836     "url": "/api/userProfile/resources/{id}",
28837     "title": "Update an existing User Profile Resource",
28838     "examples": [
28839       {
28840         "title": "Example usage:",
28841         "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",
28842         "type": "json"
28843       }
28844     ],
28845     "name": "updateUser_Profile_Resources",
28846     "group": "User_Profile_Resources",
28847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28848     "version": "0.0.0",
28849     "filename": "server/api/userProfileResource/index.js",
28850     "groupTitle": "User_Profile_Resources"
28851   },
28852   {
28853     "type": "post",
28854     "url": "/api/userProfile/sections",
28855     "title": "Creates a new User Profile Section",
28856     "examples": [
28857       {
28858         "title": "Example usage:",
28859         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28860         "type": "json"
28861       }
28862     ],
28863     "name": "CreateUser_Profile_Sections",
28864     "group": "User_Profile_Sections",
28865     "parameter": {
28866       "fields": {
28867         "Body": [
28868           {
28869             "group": "Body",
28870             "type": "String",
28871             "optional": false,
28872             "field": "name",
28873             "description": ""
28874           },
28875           {
28876             "group": "Body",
28877             "type": "String",
28878             "optional": false,
28879             "field": "category",
28880             "description": ""
28881           },
28882           {
28883             "group": "Body",
28884             "type": "Integer",
28885             "optional": false,
28886             "field": "sectionId",
28887             "description": ""
28888           },
28889           {
28890             "group": "Body",
28891             "type": "Boolean",
28892             "optional": true,
28893             "field": "enabled",
28894             "description": ""
28895           },
28896           {
28897             "group": "Body",
28898             "type": "Boolean",
28899             "optional": true,
28900             "field": "autoAssociation",
28901             "description": ""
28902           },
28903           {
28904             "group": "Body",
28905             "type": "String",
28906             "optional": true,
28907             "field": "crudPermissions",
28908             "description": ""
28909           }
28910         ]
28911       }
28912     },
28913     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28914     "version": "0.0.0",
28915     "filename": "server/api/userProfileSection/index.js",
28916     "groupTitle": "User_Profile_Sections"
28917   },
28918   {
28919     "type": "delete",
28920     "url": "/api/userProfile/sections/{id}",
28921     "title": "Deletes a User Profile Section",
28922     "examples": [
28923       {
28924         "title": "Example usage:",
28925         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28926         "type": "json"
28927       }
28928     ],
28929     "name": "DeleteUser_Profile_Sections",
28930     "group": "User_Profile_Sections",
28931     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28932     "version": "0.0.0",
28933     "filename": "server/api/userProfileSection/index.js",
28934     "groupTitle": "User_Profile_Sections"
28935   },
28936   {
28937     "type": "get",
28938     "url": "/api/userProfile/sections/describe",
28939     "title": "Gets table info about User Profile Sections",
28940     "examples": [
28941       {
28942         "title": "Example usage:",
28943         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28944         "type": "json"
28945       }
28946     ],
28947     "name": "DescribeUser_Profile_Sections",
28948     "group": "User_Profile_Sections",
28949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28950     "version": "0.0.0",
28951     "filename": "server/api/userProfileSection/index.js",
28952     "groupTitle": "User_Profile_Sections"
28953   },
28954   {
28955     "type": "get",
28956     "url": "/api/userProfile/sections",
28957     "title": "Gets a list of User Profile Sections",
28958     "examples": [
28959       {
28960         "title": "Example usage:",
28961         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28962         "type": "json"
28963       }
28964     ],
28965     "name": "GetUser_Profile_Sections",
28966     "group": "User_Profile_Sections",
28967     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28968     "version": "0.0.0",
28969     "filename": "server/api/userProfileSection/index.js",
28970     "groupTitle": "User_Profile_Sections"
28971   },
28972   {
28973     "type": "get",
28974     "url": "/api/userProfile/sections/{id}",
28975     "title": "Gets a single User Profile Section",
28976     "examples": [
28977       {
28978         "title": "Example usage:",
28979         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28980         "type": "json"
28981       }
28982     ],
28983     "name": "ShowUser_Profile_Sections",
28984     "group": "User_Profile_Sections",
28985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28986     "version": "0.0.0",
28987     "filename": "server/api/userProfileSection/index.js",
28988     "groupTitle": "User_Profile_Sections"
28989   },
28990   {
28991     "type": "put",
28992     "url": "/api/userProfile/sections/{id}",
28993     "title": "Update an existing User Profile Section",
28994     "examples": [
28995       {
28996         "title": "Example usage:",
28997         "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",
28998         "type": "json"
28999       }
29000     ],
29001     "name": "updateUser_Profile_Sections",
29002     "group": "User_Profile_Sections",
29003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29004     "version": "0.0.0",
29005     "filename": "server/api/userProfileSection/index.js",
29006     "groupTitle": "User_Profile_Sections"
29007   },
29008   {
29009     "type": "post",
29010     "url": "/api/userProfiles/{id}/resources",
29011     "title": "Add resources' permissions to User Profile",
29012     "examples": [
29013       {
29014         "title": "Example usage:",
29015         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29016         "type": "json"
29017       }
29018     ],
29019     "name": "AddResources",
29020     "group": "User_Profiles",
29021     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29022     "version": "0.0.0",
29023     "filename": "server/api/userProfile/index.js",
29024     "groupTitle": "User_Profiles"
29025   },
29026   {
29027     "type": "post",
29028     "url": "/api/userProfiles/{id}/sections",
29029     "title": "Add sections' permissions to User Profile",
29030     "examples": [
29031       {
29032         "title": "Example usage:",
29033         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29034         "type": "json"
29035       }
29036     ],
29037     "name": "AddSections",
29038     "group": "User_Profiles",
29039     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29040     "version": "0.0.0",
29041     "filename": "server/api/userProfile/index.js",
29042     "groupTitle": "User_Profiles"
29043   },
29044   {
29045     "type": "post",
29046     "url": "/api/userProfiles/clone",
29047     "title": "Clone an existing User Profile",
29048     "examples": [
29049       {
29050         "title": "Example usage:",
29051         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29052         "type": "json"
29053       }
29054     ],
29055     "name": "CloneUser_Profiles",
29056     "group": "User_Profiles",
29057     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29058     "version": "0.0.0",
29059     "filename": "server/api/userProfile/index.js",
29060     "groupTitle": "User_Profiles"
29061   },
29062   {
29063     "type": "post",
29064     "url": "/api/userProfiles",
29065     "title": "Creates a new User Profile",
29066     "examples": [
29067       {
29068         "title": "Example usage:",
29069         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29070         "type": "json"
29071       }
29072     ],
29073     "name": "CreateUser_Profiles",
29074     "group": "User_Profiles",
29075     "parameter": {
29076       "fields": {
29077         "Body": [
29078           {
29079             "group": "Body",
29080             "type": "String",
29081             "optional": false,
29082             "field": "name",
29083             "description": ""
29084           },
29085           {
29086             "group": "Body",
29087             "type": "String",
29088             "optional": false,
29089             "field": "crudPermissions",
29090             "description": ""
29091           },
29092           {
29093             "group": "Body",
29094             "type": "String",
29095             "optional": true,
29096             "field": "description",
29097             "description": ""
29098           },
29099           {
29100             "group": "Body",
29101             "type": "Boolean",
29102             "optional": true,
29103             "field": "privacyEnabled",
29104             "description": ""
29105           },
29106           {
29107             "group": "Body",
29108             "type": "Boolean",
29109             "optional": true,
29110             "field": "downloadAttachments",
29111             "description": ""
29112           },
29113           {
29114             "group": "Body",
29115             "type": "Boolean",
29116             "optional": true,
29117             "field": "downloadCallySquareRecordings",
29118             "description": ""
29119           },
29120           {
29121             "group": "Body",
29122             "type": "Boolean",
29123             "optional": true,
29124             "field": "downloadContactManagerLists",
29125             "description": ""
29126           },
29127           {
29128             "group": "Body",
29129             "type": "Boolean",
29130             "optional": true,
29131             "field": "downloadJscriptySessions",
29132             "description": ""
29133           },
29134           {
29135             "group": "Body",
29136             "type": "Boolean",
29137             "optional": true,
29138             "field": "downloadOmnichannelInteractions",
29139             "description": ""
29140           },
29141           {
29142             "group": "Body",
29143             "type": "Boolean",
29144             "optional": true,
29145             "field": "downloadScreenRecordings",
29146             "description": ""
29147           },
29148           {
29149             "group": "Body",
29150             "type": "Boolean",
29151             "optional": true,
29152             "field": "downloadVoiceRecordings",
29153             "description": ""
29154           }
29155         ]
29156       }
29157     },
29158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29159     "version": "0.0.0",
29160     "filename": "server/api/userProfile/index.js",
29161     "groupTitle": "User_Profiles"
29162   },
29163   {
29164     "type": "delete",
29165     "url": "/api/userProfiles/{id}",
29166     "title": "Deletes a User Profile",
29167     "examples": [
29168       {
29169         "title": "Example usage:",
29170         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
29171         "type": "json"
29172       }
29173     ],
29174     "name": "DeleteUser_Profiles",
29175     "group": "User_Profiles",
29176     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29177     "version": "0.0.0",
29178     "filename": "server/api/userProfile/index.js",
29179     "groupTitle": "User_Profiles"
29180   },
29181   {
29182     "type": "get",
29183     "url": "/api/userProfiles/describe",
29184     "title": "Gets table info about User Profiles",
29185     "examples": [
29186       {
29187         "title": "Example usage:",
29188         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
29189         "type": "json"
29190       }
29191     ],
29192     "name": "DescribeUser_Profiles",
29193     "group": "User_Profiles",
29194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29195     "version": "0.0.0",
29196     "filename": "server/api/userProfile/index.js",
29197     "groupTitle": "User_Profiles"
29198   },
29199   {
29200     "type": "get",
29201     "url": "/api/userProfiles/{id}/resources?section={section}",
29202     "title": "Get Resources assigned to a Section",
29203     "examples": [
29204       {
29205         "title": "Example usage:",
29206         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
29207         "type": "json"
29208       }
29209     ],
29210     "name": "GetResources",
29211     "group": "User_Profiles",
29212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29213     "version": "0.0.0",
29214     "filename": "server/api/userProfile/index.js",
29215     "groupTitle": "User_Profiles"
29216   },
29217   {
29218     "type": "get",
29219     "url": "/api/userProfiles/{id}/sections",
29220     "title": "Get sections associated to a User Profile",
29221     "examples": [
29222       {
29223         "title": "Example usage:",
29224         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
29225         "type": "json"
29226       }
29227     ],
29228     "name": "GetSections",
29229     "group": "User_Profiles",
29230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29231     "version": "0.0.0",
29232     "filename": "server/api/userProfile/index.js",
29233     "groupTitle": "User_Profiles"
29234   },
29235   {
29236     "type": "get",
29237     "url": "/api/userProfiles",
29238     "title": "Gets a list of User Profiles",
29239     "examples": [
29240       {
29241         "title": "Example usage:",
29242         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
29243         "type": "json"
29244       }
29245     ],
29246     "name": "GetUser_Profiles",
29247     "group": "User_Profiles",
29248     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29249     "version": "0.0.0",
29250     "filename": "server/api/userProfile/index.js",
29251     "groupTitle": "User_Profiles"
29252   },
29253   {
29254     "type": "delete",
29255     "url": "/api/userProfiles/{id}/resources",
29256     "title": "Removes resources' permissions from User Profile",
29257     "examples": [
29258       {
29259         "title": "Example usage:",
29260         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29261         "type": "json"
29262       }
29263     ],
29264     "name": "RemoveResources",
29265     "group": "User_Profiles",
29266     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29267     "version": "0.0.0",
29268     "filename": "server/api/userProfile/index.js",
29269     "groupTitle": "User_Profiles"
29270   },
29271   {
29272     "type": "delete",
29273     "url": "/api/userProfiles/{id}/sections",
29274     "title": "Removes sections' permissions from User Profile",
29275     "examples": [
29276       {
29277         "title": "Example usage:",
29278         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29279         "type": "json"
29280       }
29281     ],
29282     "name": "RemoveSections",
29283     "group": "User_Profiles",
29284     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29285     "version": "0.0.0",
29286     "filename": "server/api/userProfile/index.js",
29287     "groupTitle": "User_Profiles"
29288   },
29289   {
29290     "type": "get",
29291     "url": "/api/userProfiles/{id}",
29292     "title": "Gets a single User Profile",
29293     "examples": [
29294       {
29295         "title": "Example usage:",
29296         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29297         "type": "json"
29298       }
29299     ],
29300     "name": "ShowUser_Profiles",
29301     "group": "User_Profiles",
29302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29303     "version": "0.0.0",
29304     "filename": "server/api/userProfile/index.js",
29305     "groupTitle": "User_Profiles"
29306   },
29307   {
29308     "type": "put",
29309     "url": "/api/userProfiles/{id}",
29310     "title": "Update an existing User Profile",
29311     "examples": [
29312       {
29313         "title": "Example usage:",
29314         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29315         "type": "json"
29316       }
29317     ],
29318     "name": "updateUser_Profiles",
29319     "group": "User_Profiles",
29320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29321     "version": "0.0.0",
29322     "filename": "server/api/userProfile/index.js",
29323     "groupTitle": "User_Profiles"
29324   },
29325   {
29326     "type": "put",
29327     "url": "/api/user-settings/{id}",
29328     "title": "Update an existing User Setting",
29329     "examples": [
29330       {
29331         "title": "Example usage:",
29332         "content": "curl https://{domain}/api/user-settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29333         "type": "json"
29334       }
29335     ],
29336     "name": "updateUserSettings",
29337     "group": "User_Settings",
29338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29339     "version": "0.0.0",
29340     "filename": "server/api/user-setting/index.js",
29341     "groupTitle": "User_Settings"
29342   },
29343   {
29344     "type": "post",
29345     "url": "/api/users/{id}/chat_interactions",
29346     "title": "Add chat interaction tabs to an agent",
29347     "examples": [
29348       {
29349         "title": "Example usage:",
29350         "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",
29351         "type": "json"
29352       }
29353     ],
29354     "name": "AddChatInteractions",
29355     "group": "Users",
29356     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29357     "version": "0.0.0",
29358     "filename": "server/api/user/index.js",
29359     "groupTitle": "Users"
29360   },
29361   {
29362     "type": "post",
29363     "url": "/api/users/{id}/chat_websites",
29364     "title": "Add a Chat Website to a user",
29365     "examples": [
29366       {
29367         "title": "Example usage:",
29368         "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",
29369         "type": "json"
29370       }
29371     ],
29372     "name": "AddChatWebsites",
29373     "group": "Users",
29374     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29375     "version": "0.0.0",
29376     "filename": "server/api/user/index.js",
29377     "groupTitle": "Users"
29378   },
29379   {
29380     "type": "post",
29381     "url": "/api/users/{id}/contacts",
29382     "title": "Add contacts to a user",
29383     "examples": [
29384       {
29385         "title": "Example usage:",
29386         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29387         "type": "json"
29388       }
29389     ],
29390     "name": "AddContacts",
29391     "group": "Users",
29392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29393     "version": "0.0.0",
29394     "filename": "server/api/user/index.js",
29395     "groupTitle": "Users"
29396   },
29397   {
29398     "type": "post",
29399     "url": "/api/users/{id}/fax_accounts",
29400     "title": "Add a Fax Account to a user",
29401     "examples": [
29402       {
29403         "title": "Example usage:",
29404         "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",
29405         "type": "json"
29406       }
29407     ],
29408     "name": "AddFaxAccounts",
29409     "group": "Users",
29410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29411     "version": "0.0.0",
29412     "filename": "server/api/user/index.js",
29413     "groupTitle": "Users"
29414   },
29415   {
29416     "type": "post",
29417     "url": "/api/users/{id}/fax_interactions",
29418     "title": "Add fax interaction tabs to an agent",
29419     "examples": [
29420       {
29421         "title": "Example usage:",
29422         "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",
29423         "type": "json"
29424       }
29425     ],
29426     "name": "AddFaxInteractions",
29427     "group": "Users",
29428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29429     "version": "0.0.0",
29430     "filename": "server/api/user/index.js",
29431     "groupTitle": "Users"
29432   },
29433   {
29434     "type": "post",
29435     "url": "/api/users/{id}/mail_accounts",
29436     "title": "Add a Mail Account to a user",
29437     "examples": [
29438       {
29439         "title": "Example usage:",
29440         "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",
29441         "type": "json"
29442       }
29443     ],
29444     "name": "AddMailAccounts",
29445     "group": "Users",
29446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29447     "version": "0.0.0",
29448     "filename": "server/api/user/index.js",
29449     "groupTitle": "Users"
29450   },
29451   {
29452     "type": "post",
29453     "url": "/api/users/{id}/mail_interactions",
29454     "title": "Add mail interaction tabs to an agent",
29455     "examples": [
29456       {
29457         "title": "Example usage:",
29458         "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",
29459         "type": "json"
29460       }
29461     ],
29462     "name": "AddMailInteractions",
29463     "group": "Users",
29464     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29465     "version": "0.0.0",
29466     "filename": "server/api/user/index.js",
29467     "groupTitle": "Users"
29468   },
29469   {
29470     "type": "post",
29471     "url": "/api/users/{id}/openchannel_accounts",
29472     "title": "Add a Open Channel Account to a user",
29473     "examples": [
29474       {
29475         "title": "Example usage:",
29476         "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",
29477         "type": "json"
29478       }
29479     ],
29480     "name": "AddOpenchannelAccounts",
29481     "group": "Users",
29482     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29483     "version": "0.0.0",
29484     "filename": "server/api/user/index.js",
29485     "groupTitle": "Users"
29486   },
29487   {
29488     "type": "post",
29489     "url": "/api/users/{id}/openchannel_interactions",
29490     "title": "Add openchannel interaction tabs to an agent",
29491     "examples": [
29492       {
29493         "title": "Example usage:",
29494         "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",
29495         "type": "json"
29496       }
29497     ],
29498     "name": "AddOpenchannelInteractions",
29499     "group": "Users",
29500     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29501     "version": "0.0.0",
29502     "filename": "server/api/user/index.js",
29503     "groupTitle": "Users"
29504   },
29505   {
29506     "type": "post",
29507     "url": "/api/users/{id}/queues",
29508     "title": "Add queues to an agent",
29509     "examples": [
29510       {
29511         "title": "Example usage:",
29512         "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",
29513         "type": "json"
29514       }
29515     ],
29516     "name": "AddQueues",
29517     "group": "Users",
29518     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29519     "version": "0.0.0",
29520     "filename": "server/api/user/index.js",
29521     "groupTitle": "Users"
29522   },
29523   {
29524     "type": "post",
29525     "url": "/api/users/{id}/sms_accounts",
29526     "title": "Add a Sms Account to a user",
29527     "examples": [
29528       {
29529         "title": "Example usage:",
29530         "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",
29531         "type": "json"
29532       }
29533     ],
29534     "name": "AddSmsAccounts",
29535     "group": "Users",
29536     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29537     "version": "0.0.0",
29538     "filename": "server/api/user/index.js",
29539     "groupTitle": "Users"
29540   },
29541   {
29542     "type": "post",
29543     "url": "/api/users/{id}/sms_interactions",
29544     "title": "Add sms interaction tabs to an agent",
29545     "examples": [
29546       {
29547         "title": "Example usage:",
29548         "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",
29549         "type": "json"
29550       }
29551     ],
29552     "name": "AddSmsInteractions",
29553     "group": "Users",
29554     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29555     "version": "0.0.0",
29556     "filename": "server/api/user/index.js",
29557     "groupTitle": "Users"
29558   },
29559   {
29560     "type": "post",
29561     "url": "/api/users/{id}/teams",
29562     "title": "Add teams to an agent",
29563     "examples": [
29564       {
29565         "title": "Example usage:",
29566         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29567         "type": "json"
29568       }
29569     ],
29570     "name": "AddTeams",
29571     "group": "Users",
29572     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29573     "version": "0.0.0",
29574     "filename": "server/api/user/index.js",
29575     "groupTitle": "Users"
29576   },
29577   {
29578     "type": "post",
29579     "url": "/api/users/{id}/whatsapp_accounts",
29580     "title": "Add a Whatsapp Account to a user",
29581     "examples": [
29582       {
29583         "title": "Example usage:",
29584         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29585         "type": "json"
29586       }
29587     ],
29588     "name": "AddWhatsappAccounts",
29589     "group": "Users",
29590     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29591     "version": "0.0.0",
29592     "filename": "server/api/user/index.js",
29593     "groupTitle": "Users"
29594   },
29595   {
29596     "type": "post",
29597     "url": "/api/users/{id}/whatsapp_interactions",
29598     "title": "Add Whatsapp interaction tabs to an agent",
29599     "examples": [
29600       {
29601         "title": "Example usage:",
29602         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29603         "type": "json"
29604       }
29605     ],
29606     "name": "AddWhatsappInteractions",
29607     "group": "Users",
29608     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29609     "version": "0.0.0",
29610     "filename": "server/api/user/index.js",
29611     "groupTitle": "Users"
29612   },
29613   {
29614     "type": "put",
29615     "url": "/api/users/{id}/password",
29616     "title": "Change user password",
29617     "examples": [
29618       {
29619         "title": "Example usage:",
29620         "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",
29621         "type": "json"
29622       }
29623     ],
29624     "name": "ChangePwd",
29625     "group": "Users",
29626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29627     "version": "0.0.0",
29628     "filename": "server/api/user/index.js",
29629     "groupTitle": "Users"
29630   },
29631   {
29632     "type": "post",
29633     "url": "/api/users",
29634     "title": "Create a new user",
29635     "examples": [
29636       {
29637         "title": "Example usage:",
29638         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29639         "type": "json"
29640       }
29641     ],
29642     "name": "Create",
29643     "group": "Users",
29644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29645     "version": "0.0.0",
29646     "filename": "server/api/user/index.js",
29647     "groupTitle": "Users"
29648   },
29649   {
29650     "type": "post",
29651     "url": "/api/users/{id}/api_key",
29652     "title": "Create a new API access key for the user",
29653     "examples": [
29654       {
29655         "title": "Example usage:",
29656         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29657         "type": "json"
29658       }
29659     ],
29660     "name": "CreateApiKey",
29661     "group": "Users",
29662     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29663     "version": "0.0.0",
29664     "filename": "server/api/user/index.js",
29665     "groupTitle": "Users"
29666   },
29667   {
29668     "type": "delete",
29669     "url": "/api/users/{id}",
29670     "title": "Deletes a user",
29671     "examples": [
29672       {
29673         "title": "Example usage:",
29674         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29675         "type": "json"
29676       }
29677     ],
29678     "name": "Delete",
29679     "group": "Users",
29680     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29681     "version": "0.0.0",
29682     "filename": "server/api/user/index.js",
29683     "groupTitle": "Users"
29684   },
29685   {
29686     "type": "get",
29687     "url": "/api/users/describe",
29688     "title": "Gets table info about Users",
29689     "examples": [
29690       {
29691         "title": "Example usage:",
29692         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29693         "type": "json"
29694       }
29695     ],
29696     "name": "DescribeUsers",
29697     "group": "Users",
29698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29699     "version": "0.0.0",
29700     "filename": "server/api/user/index.js",
29701     "groupTitle": "Users"
29702   },
29703   {
29704     "type": "get",
29705     "url": "/api/users/{id}/agents",
29706     "title": "GetAgents",
29707     "examples": [
29708       {
29709         "title": "Example usage:",
29710         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29711         "type": "json"
29712       }
29713     ],
29714     "name": "GetAgents",
29715     "group": "Users",
29716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29717     "version": "0.0.0",
29718     "filename": "server/api/user/index.js",
29719     "groupTitle": "Users"
29720   },
29721   {
29722     "type": "get",
29723     "url": "/api/users/{id}/api_key",
29724     "title": "Get the API access key for the user",
29725     "examples": [
29726       {
29727         "title": "Example usage:",
29728         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29729         "type": "json"
29730       }
29731     ],
29732     "name": "GetApiKey",
29733     "group": "Users",
29734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29735     "version": "0.0.0",
29736     "filename": "server/api/user/index.js",
29737     "groupTitle": "Users"
29738   },
29739   {
29740     "type": "get",
29741     "url": "/api/users/{id}/groups",
29742     "title": "GetChatGroups",
29743     "examples": [
29744       {
29745         "title": "Example usage:",
29746         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29747         "type": "json"
29748       }
29749     ],
29750     "name": "GetChatGroups",
29751     "group": "Users",
29752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29753     "version": "0.0.0",
29754     "filename": "server/api/user/index.js",
29755     "groupTitle": "Users"
29756   },
29757   {
29758     "type": "get",
29759     "url": "/api/users/{id}/chat/interactions",
29760     "title": "GetChatInteractions",
29761     "examples": [
29762       {
29763         "title": "Example usage:",
29764         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29765         "type": "json"
29766       }
29767     ],
29768     "name": "GetChatInteractions",
29769     "group": "Users",
29770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29771     "version": "0.0.0",
29772     "filename": "server/api/user/index.js",
29773     "groupTitle": "Users"
29774   },
29775   {
29776     "type": "get",
29777     "url": "/api/users/{id}/chat_websites",
29778     "title": "GetChatWebsites",
29779     "examples": [
29780       {
29781         "title": "Example usage:",
29782         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29783         "type": "json"
29784       }
29785     ],
29786     "name": "GetChatWebsites",
29787     "group": "Users",
29788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29789     "version": "0.0.0",
29790     "filename": "server/api/user/index.js",
29791     "groupTitle": "Users"
29792   },
29793   {
29794     "type": "get",
29795     "url": "/api/users/{id}/contacts",
29796     "title": "GetContacts",
29797     "examples": [
29798       {
29799         "title": "Example usage:",
29800         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29801         "type": "json"
29802       }
29803     ],
29804     "name": "GetContacts",
29805     "group": "Users",
29806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29807     "version": "0.0.0",
29808     "filename": "server/api/user/index.js",
29809     "groupTitle": "Users"
29810   },
29811   {
29812     "type": "get",
29813     "url": "/api/users/{id}/fax_accounts",
29814     "title": "GetFaxAccounts",
29815     "examples": [
29816       {
29817         "title": "Example usage:",
29818         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29819         "type": "json"
29820       }
29821     ],
29822     "name": "GetFaxAccounts",
29823     "group": "Users",
29824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29825     "version": "0.0.0",
29826     "filename": "server/api/user/index.js",
29827     "groupTitle": "Users"
29828   },
29829   {
29830     "type": "get",
29831     "url": "/api/users/{id}/fax/interactions",
29832     "title": "GetFaxInteractions",
29833     "examples": [
29834       {
29835         "title": "Example usage:",
29836         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29837         "type": "json"
29838       }
29839     ],
29840     "name": "GetFaxInteractions",
29841     "group": "Users",
29842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29843     "version": "0.0.0",
29844     "filename": "server/api/user/index.js",
29845     "groupTitle": "Users"
29846   },
29847   {
29848     "type": "get",
29849     "url": "/api/users/{id}/lists",
29850     "title": "GetLists",
29851     "examples": [
29852       {
29853         "title": "Example usage:",
29854         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29855         "type": "json"
29856       }
29857     ],
29858     "name": "GetLists",
29859     "group": "Users",
29860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29861     "version": "0.0.0",
29862     "filename": "server/api/user/index.js",
29863     "groupTitle": "Users"
29864   },
29865   {
29866     "type": "get",
29867     "url": "/api/users/{id}/mail_accounts",
29868     "title": "GetMailAccounts",
29869     "examples": [
29870       {
29871         "title": "Example usage:",
29872         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29873         "type": "json"
29874       }
29875     ],
29876     "name": "GetMailAccounts",
29877     "group": "Users",
29878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29879     "version": "0.0.0",
29880     "filename": "server/api/user/index.js",
29881     "groupTitle": "Users"
29882   },
29883   {
29884     "type": "get",
29885     "url": "/api/users/{id}/mail/interactions",
29886     "title": "GetMailInteractions",
29887     "examples": [
29888       {
29889         "title": "Example usage:",
29890         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29891         "type": "json"
29892       }
29893     ],
29894     "name": "GetMailInteractions",
29895     "group": "Users",
29896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29897     "version": "0.0.0",
29898     "filename": "server/api/user/index.js",
29899     "groupTitle": "Users"
29900   },
29901   {
29902     "type": "get",
29903     "url": "/api/users/{id}/openchannel_accounts",
29904     "title": "GetOpenchannelAccounts",
29905     "examples": [
29906       {
29907         "title": "Example usage:",
29908         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29909         "type": "json"
29910       }
29911     ],
29912     "name": "GetOpenchannelAccounts",
29913     "group": "Users",
29914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29915     "version": "0.0.0",
29916     "filename": "server/api/user/index.js",
29917     "groupTitle": "Users"
29918   },
29919   {
29920     "type": "get",
29921     "url": "/api/users/{id}/openchannel/interactions",
29922     "title": "GetOpenchannelInteractions",
29923     "examples": [
29924       {
29925         "title": "Example usage:",
29926         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29927         "type": "json"
29928       }
29929     ],
29930     "name": "GetOpenchannelInteractions",
29931     "group": "Users",
29932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29933     "version": "0.0.0",
29934     "filename": "server/api/user/index.js",
29935     "groupTitle": "Users"
29936   },
29937   {
29938     "type": "get",
29939     "url": "/api/users/{id}/prefixes",
29940     "title": "GetPrefixes",
29941     "examples": [
29942       {
29943         "title": "Example usage:",
29944         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29945         "type": "json"
29946       }
29947     ],
29948     "name": "GetPrefixes",
29949     "group": "Users",
29950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29951     "version": "0.0.0",
29952     "filename": "server/api/user/index.js",
29953     "groupTitle": "Users"
29954   },
29955   {
29956     "type": "get",
29957     "url": "/api/users/{id}/queues?channel={channel}",
29958     "title": "Gets Queues list",
29959     "examples": [
29960       {
29961         "title": "Example usage:",
29962         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29963         "type": "json"
29964       }
29965     ],
29966     "name": "GetQueues",
29967     "group": "Users",
29968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29969     "version": "0.0.0",
29970     "filename": "server/api/user/index.js",
29971     "groupTitle": "Users"
29972   },
29973   {
29974     "type": "get",
29975     "url": "/api/users/{id}/recordings",
29976     "title": "GetRecordings",
29977     "examples": [
29978       {
29979         "title": "Example usage:",
29980         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29981         "type": "json"
29982       }
29983     ],
29984     "name": "GetRecordings",
29985     "group": "Users",
29986     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29987     "version": "0.0.0",
29988     "filename": "server/api/user/index.js",
29989     "groupTitle": "Users"
29990   },
29991   {
29992     "type": "get",
29993     "url": "/api/users/{id}/scheduled_calls",
29994     "title": "GetScheduledCalls",
29995     "examples": [
29996       {
29997         "title": "Example usage:",
29998         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29999         "type": "json"
30000       }
30001     ],
30002     "name": "GetScheduledCalls",
30003     "group": "Users",
30004     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30005     "version": "0.0.0",
30006     "filename": "server/api/user/index.js",
30007     "groupTitle": "Users"
30008   },
30009   {
30010     "type": "get",
30011     "url": "/api/users/{id}/screen_recordings",
30012     "title": "GetScreenRecordings",
30013     "examples": [
30014       {
30015         "title": "Example usage:",
30016         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
30017         "type": "json"
30018       }
30019     ],
30020     "name": "GetScreenRecordings",
30021     "group": "Users",
30022     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30023     "version": "0.0.0",
30024     "filename": "server/api/user/index.js",
30025     "groupTitle": "Users"
30026   },
30027   {
30028     "type": "get",
30029     "url": "/api/users/{id}/sms_accounts",
30030     "title": "GetSmsAccounts",
30031     "examples": [
30032       {
30033         "title": "Example usage:",
30034         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
30035         "type": "json"
30036       }
30037     ],
30038     "name": "GetSmsAccounts",
30039     "group": "Users",
30040     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30041     "version": "0.0.0",
30042     "filename": "server/api/user/index.js",
30043     "groupTitle": "Users"
30044   },
30045   {
30046     "type": "get",
30047     "url": "/api/users/{id}/sms/interactions",
30048     "title": "GetSmsInteractions",
30049     "examples": [
30050       {
30051         "title": "Example usage:",
30052         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
30053         "type": "json"
30054       }
30055     ],
30056     "name": "GetSmsInteractions",
30057     "group": "Users",
30058     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30059     "version": "0.0.0",
30060     "filename": "server/api/user/index.js",
30061     "groupTitle": "Users"
30062   },
30063   {
30064     "type": "get",
30065     "url": "/api/users/{id}/teams",
30066     "title": "GetTeams",
30067     "examples": [
30068       {
30069         "title": "Example usage:",
30070         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30071         "type": "json"
30072       }
30073     ],
30074     "name": "GetTeams",
30075     "group": "Users",
30076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30077     "version": "0.0.0",
30078     "filename": "server/api/user/index.js",
30079     "groupTitle": "Users"
30080   },
30081   {
30082     "type": "get",
30083     "url": "/api/users",
30084     "title": "Gets a list of Users",
30085     "examples": [
30086       {
30087         "title": "Example usage:",
30088         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30089         "type": "json"
30090       }
30091     ],
30092     "name": "GetUsers",
30093     "group": "Users",
30094     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30095     "version": "0.0.0",
30096     "filename": "server/api/user/index.js",
30097     "groupTitle": "Users"
30098   },
30099   {
30100     "type": "get",
30101     "url": "/api/users/{id}/queues_rt",
30102     "title": "GetVoiceQueuesRt",
30103     "examples": [
30104       {
30105         "title": "Example usage:",
30106         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30107         "type": "json"
30108       }
30109     ],
30110     "name": "GetVoiceQueuesRt",
30111     "group": "Users",
30112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30113     "version": "0.0.0",
30114     "filename": "server/api/user/index.js",
30115     "groupTitle": "Users"
30116   },
30117   {
30118     "type": "get",
30119     "url": "/api/users/{id}/whatsapp_accounts",
30120     "title": "GetWhatsappAccounts",
30121     "examples": [
30122       {
30123         "title": "Example usage:",
30124         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30125         "type": "json"
30126       }
30127     ],
30128     "name": "GetWhatsappAccounts",
30129     "group": "Users",
30130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30131     "version": "0.0.0",
30132     "filename": "server/api/user/index.js",
30133     "groupTitle": "Users"
30134   },
30135   {
30136     "type": "get",
30137     "url": "/api/users/{id}/whatsapp/interactions",
30138     "title": "GetWhatsappInteractions",
30139     "examples": [
30140       {
30141         "title": "Example usage:",
30142         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30143         "type": "json"
30144       }
30145     ],
30146     "name": "GetWhatsappInteractions",
30147     "group": "Users",
30148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30149     "version": "0.0.0",
30150     "filename": "server/api/user/index.js",
30151     "groupTitle": "Users"
30152   },
30153   {
30154     "type": "post",
30155     "url": "/api/users/{id}/login",
30156     "title": "Login",
30157     "examples": [
30158       {
30159         "title": "Example usage:",
30160         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
30161         "type": "json"
30162       }
30163     ],
30164     "name": "Login",
30165     "group": "Users",
30166     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30167     "version": "0.0.0",
30168     "filename": "server/api/user/index.js",
30169     "groupTitle": "Users"
30170   },
30171   {
30172     "type": "post",
30173     "url": "/api/users/{id}/logout",
30174     "title": "Logout",
30175     "examples": [
30176       {
30177         "title": "Example usage:",
30178         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30179         "type": "json"
30180       }
30181     ],
30182     "name": "Logout",
30183     "group": "Users",
30184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30185     "version": "0.0.0",
30186     "filename": "server/api/user/index.js",
30187     "groupTitle": "Users"
30188   },
30189   {
30190     "type": "post",
30191     "url": "/api/users/{id}/pause",
30192     "title": "Pause",
30193     "examples": [
30194       {
30195         "title": "Example usage:",
30196         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30197         "type": "json"
30198       }
30199     ],
30200     "name": "Pause",
30201     "group": "Users",
30202     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30203     "version": "0.0.0",
30204     "filename": "server/api/user/index.js",
30205     "groupTitle": "Users"
30206   },
30207   {
30208     "type": "delete",
30209     "url": "/api/users/{id}/api_key",
30210     "title": "Remove API access key for the user",
30211     "examples": [
30212       {
30213         "title": "Example usage:",
30214         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30215         "type": "json"
30216       }
30217     ],
30218     "name": "RemoveApiKey",
30219     "group": "Users",
30220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30221     "version": "0.0.0",
30222     "filename": "server/api/user/index.js",
30223     "groupTitle": "Users"
30224   },
30225   {
30226     "type": "delete",
30227     "url": "/api/users/{id}/chat_interactions",
30228     "title": "Removes interactions from an agent",
30229     "examples": [
30230       {
30231         "title": "Example usage:",
30232         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30233         "type": "json"
30234       }
30235     ],
30236     "name": "RemoveChatInteractions",
30237     "group": "Users",
30238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30239     "version": "0.0.0",
30240     "filename": "server/api/user/index.js",
30241     "groupTitle": "Users"
30242   },
30243   {
30244     "type": "delete",
30245     "url": "/api/users/{id}/chat_websites",
30246     "title": "Removes a Chat Website from a user",
30247     "examples": [
30248       {
30249         "title": "Example usage:",
30250         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30251         "type": "json"
30252       }
30253     ],
30254     "name": "RemoveChatWebsites",
30255     "group": "Users",
30256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30257     "version": "0.0.0",
30258     "filename": "server/api/user/index.js",
30259     "groupTitle": "Users"
30260   },
30261   {
30262     "type": "delete",
30263     "url": "/api/users/{id}/fax_accounts",
30264     "title": "Removes a Fax Account from a user",
30265     "examples": [
30266       {
30267         "title": "Example usage:",
30268         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30269         "type": "json"
30270       }
30271     ],
30272     "name": "RemoveFaxAccounts",
30273     "group": "Users",
30274     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30275     "version": "0.0.0",
30276     "filename": "server/api/user/index.js",
30277     "groupTitle": "Users"
30278   },
30279   {
30280     "type": "delete",
30281     "url": "/api/users/{id}/fax_interactions",
30282     "title": "Removes interactions from an agent",
30283     "examples": [
30284       {
30285         "title": "Example usage:",
30286         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30287         "type": "json"
30288       }
30289     ],
30290     "name": "RemoveFaxInteractions",
30291     "group": "Users",
30292     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30293     "version": "0.0.0",
30294     "filename": "server/api/user/index.js",
30295     "groupTitle": "Users"
30296   },
30297   {
30298     "type": "delete",
30299     "url": "/api/users/{id}/mail_accounts",
30300     "title": "Removes a Mail Account from a user",
30301     "examples": [
30302       {
30303         "title": "Example usage:",
30304         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30305         "type": "json"
30306       }
30307     ],
30308     "name": "RemoveMailAccounts",
30309     "group": "Users",
30310     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30311     "version": "0.0.0",
30312     "filename": "server/api/user/index.js",
30313     "groupTitle": "Users"
30314   },
30315   {
30316     "type": "delete",
30317     "url": "/api/users/{id}/mail_interactions",
30318     "title": "Removes interactions from an agent",
30319     "examples": [
30320       {
30321         "title": "Example usage:",
30322         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30323         "type": "json"
30324       }
30325     ],
30326     "name": "RemoveMailInteractions",
30327     "group": "Users",
30328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30329     "version": "0.0.0",
30330     "filename": "server/api/user/index.js",
30331     "groupTitle": "Users"
30332   },
30333   {
30334     "type": "delete",
30335     "url": "/api/users/{id}/openchannel_accounts",
30336     "title": "Removes a Open Channel Account from a user",
30337     "examples": [
30338       {
30339         "title": "Example usage:",
30340         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30341         "type": "json"
30342       }
30343     ],
30344     "name": "RemoveOpenchannelAccounts",
30345     "group": "Users",
30346     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30347     "version": "0.0.0",
30348     "filename": "server/api/user/index.js",
30349     "groupTitle": "Users"
30350   },
30351   {
30352     "type": "delete",
30353     "url": "/api/users/{id}/openchannel_interactions",
30354     "title": "Removes openchannel interactions from an agent",
30355     "examples": [
30356       {
30357         "title": "Example usage:",
30358         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30359         "type": "json"
30360       }
30361     ],
30362     "name": "RemoveOpenchannelInteractions",
30363     "group": "Users",
30364     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30365     "version": "0.0.0",
30366     "filename": "server/api/user/index.js",
30367     "groupTitle": "Users"
30368   },
30369   {
30370     "type": "delete",
30371     "url": "/api/users/{id}/queues",
30372     "title": "Remove queues to an agent",
30373     "examples": [
30374       {
30375         "title": "Example usage:",
30376         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30377         "type": "json"
30378       }
30379     ],
30380     "name": "RemoveQueues",
30381     "group": "Users",
30382     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30383     "version": "0.0.0",
30384     "filename": "server/api/user/index.js",
30385     "groupTitle": "Users"
30386   },
30387   {
30388     "type": "delete",
30389     "url": "/api/users/{id}/sms_accounts",
30390     "title": "Removes a Sms Account from a user",
30391     "examples": [
30392       {
30393         "title": "Example usage:",
30394         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30395         "type": "json"
30396       }
30397     ],
30398     "name": "RemoveSmsAccounts",
30399     "group": "Users",
30400     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30401     "version": "0.0.0",
30402     "filename": "server/api/user/index.js",
30403     "groupTitle": "Users"
30404   },
30405   {
30406     "type": "delete",
30407     "url": "/api/users/{id}/sms_interactions",
30408     "title": "Removes interactions from an agent",
30409     "examples": [
30410       {
30411         "title": "Example usage:",
30412         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30413         "type": "json"
30414       }
30415     ],
30416     "name": "RemoveSmsInteractions",
30417     "group": "Users",
30418     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30419     "version": "0.0.0",
30420     "filename": "server/api/user/index.js",
30421     "groupTitle": "Users"
30422   },
30423   {
30424     "type": "delete",
30425     "url": "/api/users/{id}/teams",
30426     "title": "Removes teams from an agent",
30427     "examples": [
30428       {
30429         "title": "Example usage:",
30430         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30431         "type": "json"
30432       }
30433     ],
30434     "name": "RemoveTeams",
30435     "group": "Users",
30436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30437     "version": "0.0.0",
30438     "filename": "server/api/user/index.js",
30439     "groupTitle": "Users"
30440   },
30441   {
30442     "type": "delete",
30443     "url": "/api/users/{id}/whatsapp_accounts",
30444     "title": "Removes a Whatsapp Account from a user",
30445     "examples": [
30446       {
30447         "title": "Example usage:",
30448         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30449         "type": "json"
30450       }
30451     ],
30452     "name": "RemoveWhatsappAccounts",
30453     "group": "Users",
30454     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30455     "version": "0.0.0",
30456     "filename": "server/api/user/index.js",
30457     "groupTitle": "Users"
30458   },
30459   {
30460     "type": "delete",
30461     "url": "/api/users/{id}/whatsapp_interactions",
30462     "title": "Removes Whatsapp interactions from an agent",
30463     "examples": [
30464       {
30465         "title": "Example usage:",
30466         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30467         "type": "json"
30468       }
30469     ],
30470     "name": "RemoveWhatsappInteractions",
30471     "group": "Users",
30472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30473     "version": "0.0.0",
30474     "filename": "server/api/user/index.js",
30475     "groupTitle": "Users"
30476   },
30477   {
30478     "type": "get",
30479     "url": "/api/users/{id}",
30480     "title": "Gets a single User",
30481     "examples": [
30482       {
30483         "title": "Example usage:",
30484         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30485         "type": "json"
30486       }
30487     ],
30488     "name": "ShowUsers",
30489     "group": "Users",
30490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30491     "version": "0.0.0",
30492     "filename": "server/api/user/index.js",
30493     "groupTitle": "Users"
30494   },
30495   {
30496     "type": "post",
30497     "url": "/api/users/{id}/unpause",
30498     "title": "Unpause",
30499     "examples": [
30500       {
30501         "title": "Example usage:",
30502         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30503         "type": "json"
30504       }
30505     ],
30506     "name": "Unpause",
30507     "group": "Users",
30508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30509     "version": "0.0.0",
30510     "filename": "server/api/user/index.js",
30511     "groupTitle": "Users"
30512   },
30513   {
30514     "type": "get",
30515     "url": "/api/users/whoami",
30516     "title": "WhoAmI",
30517     "examples": [
30518       {
30519         "title": "Example usage:",
30520         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30521         "type": "json"
30522       }
30523     ],
30524     "name": "WhoAmI",
30525     "group": "Users",
30526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30527     "version": "0.0.0",
30528     "filename": "server/api/user/index.js",
30529     "groupTitle": "Users"
30530   },
30531   {
30532     "type": "post",
30533     "url": "/api/users/{id}/avatar",
30534     "title": "Add avatar",
30535     "examples": [
30536       {
30537         "title": "Example usage:",
30538         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30539         "type": "json"
30540       }
30541     ],
30542     "name": "addAvatar",
30543     "group": "Users",
30544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30545     "version": "0.0.0",
30546     "filename": "server/api/user/index.js",
30547     "groupTitle": "Users"
30548   },
30549   {
30550     "type": "post",
30551     "url": "/api/users/create_many",
30552     "title": "Create Users",
30553     "examples": [
30554       {
30555         "title": "Example usage:",
30556         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30557         "type": "json"
30558       }
30559     ],
30560     "name": "bulkCreate",
30561     "group": "Users",
30562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30563     "version": "0.0.0",
30564     "filename": "server/api/user/index.js",
30565     "groupTitle": "Users"
30566   },
30567   {
30568     "type": "get",
30569     "url": "/api/users/{id}/avatar",
30570     "title": "Get avatar",
30571     "examples": [
30572       {
30573         "title": "Example usage:",
30574         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30575         "type": "json"
30576       }
30577     ],
30578     "name": "getAvatar",
30579     "group": "Users",
30580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30581     "version": "0.0.0",
30582     "filename": "server/api/user/index.js",
30583     "groupTitle": "Users"
30584   },
30585   {
30586     "type": "get",
30587     "url": "/api/users/{id}/open_tabs",
30588     "title": "Get interactions opened tabs",
30589     "examples": [
30590       {
30591         "title": "Example usage:",
30592         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30593         "type": "json"
30594       }
30595     ],
30596     "name": "getOpenTabs",
30597     "group": "Users",
30598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30599     "version": "0.0.0",
30600     "filename": "server/api/user/index.js",
30601     "groupTitle": "Users"
30602   },
30603   {
30604     "type": "get",
30605     "url": "/api/users/presence",
30606     "title": "Gets agent presence",
30607     "examples": [
30608       {
30609         "title": "Example usage:",
30610         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
30611         "type": "json"
30612       }
30613     ],
30614     "name": "getPresence",
30615     "group": "Users",
30616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30617     "version": "0.0.0",
30618     "filename": "server/api/user/index.js",
30619     "groupTitle": "Users"
30620   },
30621   {
30622     "type": "post",
30623     "url": "/api/users/{id}/messengerSoundNotification",
30624     "title": "MessengerSoundNotification",
30625     "examples": [
30626       {
30627         "title": "Example usage:",
30628         "content": "curl https://{domain}/api/users/{id}/messengerSoundNotification -v -u {name}:{password} -X POST",
30629         "type": "json"
30630       }
30631     ],
30632     "name": "messengerSoundNotification",
30633     "group": "Users",
30634     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30635     "version": "0.0.0",
30636     "filename": "server/api/user/index.js",
30637     "groupTitle": "Users"
30638   },
30639   {
30640     "type": "put",
30641     "url": "/api/users/{id}",
30642     "title": "Update an existing User",
30643     "examples": [
30644       {
30645         "title": "Example usage:",
30646         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30647         "type": "json"
30648       }
30649     ],
30650     "name": "updateUsers",
30651     "group": "Users",
30652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30653     "version": "0.0.0",
30654     "filename": "server/api/user/index.js",
30655     "groupTitle": "Users"
30656   },
30657   {
30658     "type": "post",
30659     "url": "/api/variables",
30660     "title": "Creates a new Variable",
30661     "examples": [
30662       {
30663         "title": "Example usage:",
30664         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30665         "type": "json"
30666       }
30667     ],
30668     "name": "CreateVariables",
30669     "group": "Variables",
30670     "parameter": {
30671       "fields": {
30672         "Body": [
30673           {
30674             "group": "Body",
30675             "type": "String",
30676             "optional": false,
30677             "field": "name",
30678             "description": ""
30679           },
30680           {
30681             "group": "Body",
30682             "type": "String",
30683             "optional": true,
30684             "field": "description",
30685             "description": ""
30686           }
30687         ]
30688       }
30689     },
30690     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30691     "version": "0.0.0",
30692     "filename": "server/api/variable/index.js",
30693     "groupTitle": "Variables"
30694   },
30695   {
30696     "type": "delete",
30697     "url": "/api/variables/{id}",
30698     "title": "Deletes a Variable",
30699     "examples": [
30700       {
30701         "title": "Example usage:",
30702         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30703         "type": "json"
30704       }
30705     ],
30706     "name": "DeleteVariables",
30707     "group": "Variables",
30708     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/variable/index.js",
30711     "groupTitle": "Variables"
30712   },
30713   {
30714     "type": "get",
30715     "url": "/api/variables",
30716     "title": "Gets a list of Variables",
30717     "examples": [
30718       {
30719         "title": "Example usage:",
30720         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30721         "type": "json"
30722       }
30723     ],
30724     "name": "GetVariables",
30725     "group": "Variables",
30726     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30727     "version": "0.0.0",
30728     "filename": "server/api/variable/index.js",
30729     "groupTitle": "Variables"
30730   },
30731   {
30732     "type": "get",
30733     "url": "/api/variables/{id}",
30734     "title": "Gets a single Variable",
30735     "examples": [
30736       {
30737         "title": "Example usage:",
30738         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30739         "type": "json"
30740       }
30741     ],
30742     "name": "ShowVariables",
30743     "group": "Variables",
30744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30745     "version": "0.0.0",
30746     "filename": "server/api/variable/index.js",
30747     "groupTitle": "Variables"
30748   },
30749   {
30750     "type": "put",
30751     "url": "/api/variables/{id}",
30752     "title": "Update an existing Variable",
30753     "examples": [
30754       {
30755         "title": "Example usage:",
30756         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30757         "type": "json"
30758       }
30759     ],
30760     "name": "updateVariables",
30761     "group": "Variables",
30762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30763     "version": "0.0.0",
30764     "filename": "server/api/variable/index.js",
30765     "groupTitle": "Variables"
30766   },
30767   {
30768     "type": "get",
30769     "url": "/api/version/fetch",
30770     "title": "Fetch git version",
30771     "examples": [
30772       {
30773         "title": "Example usage:",
30774         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30775         "type": "json"
30776       }
30777     ],
30778     "name": "FetchVersion",
30779     "group": "Version",
30780     "description": "<p>Motion run the following command: git fetch origin master</p>",
30781     "version": "0.0.0",
30782     "filename": "server/api/version/index.js",
30783     "groupTitle": "Version"
30784   },
30785   {
30786     "type": "get",
30787     "url": "/api/version",
30788     "title": "Gets version",
30789     "examples": [
30790       {
30791         "title": "Example usage:",
30792         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30793         "type": "json"
30794       }
30795     ],
30796     "name": "GetVersion",
30797     "group": "Version",
30798     "description": "<p>Motion returns the current and latest motion version.</p>",
30799     "version": "0.0.0",
30800     "filename": "server/api/version/index.js",
30801     "groupTitle": "Version"
30802   },
30803   {
30804     "type": "get",
30805     "url": "/api/version/migrations",
30806     "title": "Launch database migrations",
30807     "examples": [
30808       {
30809         "title": "Example usage:",
30810         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30811         "type": "json"
30812       }
30813     ],
30814     "name": "MigrateVersion",
30815     "group": "Version",
30816     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30817     "version": "0.0.0",
30818     "filename": "server/api/version/index.js",
30819     "groupTitle": "Version"
30820   },
30821   {
30822     "type": "get",
30823     "url": "/api/version/pull",
30824     "title": "Pull git version",
30825     "examples": [
30826       {
30827         "title": "Example usage:",
30828         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30829         "type": "json"
30830       }
30831     ],
30832     "name": "PullVersion",
30833     "group": "Version",
30834     "description": "<p>Motion run the following command: git pull</p>",
30835     "version": "0.0.0",
30836     "filename": "server/api/version/index.js",
30837     "groupTitle": "Version"
30838   },
30839   {
30840     "type": "get",
30841     "url": "/api/version/reset",
30842     "title": "Reset git version",
30843     "examples": [
30844       {
30845         "title": "Example usage:",
30846         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30847         "type": "json"
30848       }
30849     ],
30850     "name": "ResetVersion",
30851     "group": "Version",
30852     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30853     "version": "0.0.0",
30854     "filename": "server/api/version/index.js",
30855     "groupTitle": "Version"
30856   },
30857   {
30858     "type": "get",
30859     "url": "/api/version/restart",
30860     "title": "Restart motion2 after update",
30861     "examples": [
30862       {
30863         "title": "Example usage:",
30864         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30865         "type": "json"
30866       }
30867     ],
30868     "name": "RestartVersion",
30869     "group": "Version",
30870     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30871     "version": "0.0.0",
30872     "filename": "server/api/version/index.js",
30873     "groupTitle": "Version"
30874   },
30875   {
30876     "type": "get",
30877     "url": "/api/voice/agents/reports/describe",
30878     "title": "Gets table info about Agent Reports",
30879     "examples": [
30880       {
30881         "title": "Example usage:",
30882         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30883         "type": "json"
30884       }
30885     ],
30886     "name": "DescribeAgent_Reports",
30887     "group": "Voice_Agent_Reports",
30888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30889     "version": "0.0.0",
30890     "filename": "server/api/voiceAgentReport/index.js",
30891     "groupTitle": "Voice_Agent_Reports"
30892   },
30893   {
30894     "type": "get",
30895     "url": "/api/voice/agents/reports",
30896     "title": "Gets a list of Agent Reports",
30897     "examples": [
30898       {
30899         "title": "Example usage:",
30900         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30901         "type": "json"
30902       }
30903     ],
30904     "name": "GetAgent_Reports",
30905     "group": "Voice_Agent_Reports",
30906     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30907     "version": "0.0.0",
30908     "filename": "server/api/voiceAgentReport/index.js",
30909     "groupTitle": "Voice_Agent_Reports"
30910   },
30911   {
30912     "type": "get",
30913     "url": "/api/voice/agents/reports/{id}",
30914     "title": "Gets a single Agent Report",
30915     "examples": [
30916       {
30917         "title": "Example usage:",
30918         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30919         "type": "json"
30920       }
30921     ],
30922     "name": "ShowAgent_Reports",
30923     "group": "Voice_Agent_Reports",
30924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30925     "version": "0.0.0",
30926     "filename": "server/api/voiceAgentReport/index.js",
30927     "groupTitle": "Voice_Agent_Reports"
30928   },
30929   {
30930     "type": "get",
30931     "url": "/api/voice/calls/reports/describe",
30932     "title": "Gets table info about Call Reports",
30933     "examples": [
30934       {
30935         "title": "Example usage:",
30936         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30937         "type": "json"
30938       }
30939     ],
30940     "name": "DescribeCall_Reports",
30941     "group": "Voice_Call_Reports",
30942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30943     "version": "0.0.0",
30944     "filename": "server/api/voiceCallReport/index.js",
30945     "groupTitle": "Voice_Call_Reports"
30946   },
30947   {
30948     "type": "get",
30949     "url": "/api/voice/calls/reports",
30950     "title": "Gets a list of Call Reports",
30951     "examples": [
30952       {
30953         "title": "Example usage:",
30954         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30955         "type": "json"
30956       }
30957     ],
30958     "name": "GetCall_Reports",
30959     "group": "Voice_Call_Reports",
30960     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30961     "version": "0.0.0",
30962     "filename": "server/api/voiceCallReport/index.js",
30963     "groupTitle": "Voice_Call_Reports"
30964   },
30965   {
30966     "type": "get",
30967     "url": "/api/voice/calls/reports/{id}",
30968     "title": "Gets a single Call Report",
30969     "examples": [
30970       {
30971         "title": "Example usage:",
30972         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30973         "type": "json"
30974       }
30975     ],
30976     "name": "ShowCall_Reports",
30977     "group": "Voice_Call_Reports",
30978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30979     "version": "0.0.0",
30980     "filename": "server/api/voiceCallReport/index.js",
30981     "groupTitle": "Voice_Call_Reports"
30982   },
30983   {
30984     "type": "put",
30985     "url": "/api/voice/calls/reports/{id}",
30986     "title": "Update a single cdr",
30987     "examples": [
30988       {
30989         "title": "Example usage:",
30990         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30991         "type": "json"
30992       }
30993     ],
30994     "name": "update",
30995     "group": "Voice_Call_Reports",
30996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30997     "version": "0.0.0",
30998     "filename": "server/api/voiceCallReport/index.js",
30999     "groupTitle": "Voice_Call_Reports"
31000   },
31001   {
31002     "type": "put",
31003     "url": "/api/voice/calls/reports/{id}",
31004     "title": "Update a single cdr",
31005     "examples": [
31006       {
31007         "title": "Example usage:",
31008         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDisposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
31009         "type": "json"
31010       }
31011     ],
31012     "name": "update",
31013     "group": "Voice_Call_Reports",
31014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31015     "version": "0.0.0",
31016     "filename": "server/api/voiceCallReport/index.js",
31017     "groupTitle": "Voice_Call_Reports"
31018   },
31019   {
31020     "type": "post",
31021     "url": "/api/voice/chanspy",
31022     "title": "Creates a new ChanSpy",
31023     "examples": [
31024       {
31025         "title": "Example usage:",
31026         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31027         "type": "json"
31028       }
31029     ],
31030     "name": "CreateChanSpy",
31031     "group": "Voice_ChanSpy",
31032     "parameter": {
31033       "fields": {
31034         "Body": [
31035           {
31036             "group": "Body",
31037             "type": "String",
31038             "optional": true,
31039             "field": "name",
31040             "description": ""
31041           },
31042           {
31043             "group": "Body",
31044             "type": "String",
31045             "optional": false,
31046             "field": "prefix",
31047             "description": ""
31048           },
31049           {
31050             "group": "Body",
31051             "type": "String",
31052             "optional": true,
31053             "field": "options",
31054             "description": ""
31055           },
31056           {
31057             "group": "Body",
31058             "type": "Boolean",
31059             "optional": true,
31060             "field": "auth",
31061             "description": ""
31062           },
31063           {
31064             "group": "Body",
31065             "type": "String",
31066             "optional": true,
31067             "field": "password",
31068             "description": ""
31069           },
31070           {
31071             "group": "Body",
31072             "type": "Boolean",
31073             "optional": true,
31074             "field": "record",
31075             "description": ""
31076           },
31077           {
31078             "group": "Body",
31079             "type": "String",
31080             "optional": true,
31081             "field": "recordingFormat",
31082             "description": ""
31083           },
31084           {
31085             "group": "Body",
31086             "type": "String",
31087             "optional": true,
31088             "field": "description",
31089             "description": ""
31090           }
31091         ]
31092       }
31093     },
31094     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31095     "version": "0.0.0",
31096     "filename": "server/api/voiceChanSpy/index.js",
31097     "groupTitle": "Voice_ChanSpy"
31098   },
31099   {
31100     "type": "delete",
31101     "url": "/api/voice/chanspy/{id}",
31102     "title": "Deletes a ChanSpy",
31103     "examples": [
31104       {
31105         "title": "Example usage:",
31106         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31107         "type": "json"
31108       }
31109     ],
31110     "name": "DeleteChanSpy",
31111     "group": "Voice_ChanSpy",
31112     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31113     "version": "0.0.0",
31114     "filename": "server/api/voiceChanSpy/index.js",
31115     "groupTitle": "Voice_ChanSpy"
31116   },
31117   {
31118     "type": "get",
31119     "url": "/api/voice/chanspy",
31120     "title": "Gets a list of ChanSpy",
31121     "examples": [
31122       {
31123         "title": "Example usage:",
31124         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31125         "type": "json"
31126       }
31127     ],
31128     "name": "GetChanSpy",
31129     "group": "Voice_ChanSpy",
31130     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31131     "version": "0.0.0",
31132     "filename": "server/api/voiceChanSpy/index.js",
31133     "groupTitle": "Voice_ChanSpy"
31134   },
31135   {
31136     "type": "get",
31137     "url": "/api/voice/chanspy/{id}",
31138     "title": "Gets a single ChanSpy",
31139     "examples": [
31140       {
31141         "title": "Example usage:",
31142         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31143         "type": "json"
31144       }
31145     ],
31146     "name": "ShowChanSpy",
31147     "group": "Voice_ChanSpy",
31148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31149     "version": "0.0.0",
31150     "filename": "server/api/voiceChanSpy/index.js",
31151     "groupTitle": "Voice_ChanSpy"
31152   },
31153   {
31154     "type": "put",
31155     "url": "/api/voice/chanspy/{id}",
31156     "title": "Update an existing ChanSpy",
31157     "examples": [
31158       {
31159         "title": "Example usage:",
31160         "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",
31161         "type": "json"
31162       }
31163     ],
31164     "name": "updateChanSpy",
31165     "group": "Voice_ChanSpy",
31166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31167     "version": "0.0.0",
31168     "filename": "server/api/voiceChanSpy/index.js",
31169     "groupTitle": "Voice_ChanSpy"
31170   },
31171   {
31172     "type": "post",
31173     "url": "/api/voice/contexts",
31174     "title": "Create a new context",
31175     "examples": [
31176       {
31177         "title": "Example usage:",
31178         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31179         "type": "json"
31180       }
31181     ],
31182     "name": "Create",
31183     "group": "Voice_Contexts",
31184     "parameter": {
31185       "fields": {
31186         "Body": [
31187           {
31188             "group": "Body",
31189             "type": "String",
31190             "optional": true,
31191             "field": "name",
31192             "description": ""
31193           },
31194           {
31195             "group": "Body",
31196             "type": "String",
31197             "optional": true,
31198             "field": "description",
31199             "description": ""
31200           },
31201           {
31202             "group": "Body",
31203             "type": "Boolean",
31204             "optional": true,
31205             "field": "defaultEntry",
31206             "description": ""
31207           }
31208         ]
31209       }
31210     },
31211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31212     "version": "0.0.0",
31213     "filename": "server/api/voiceContext/index.js",
31214     "groupTitle": "Voice_Contexts"
31215   },
31216   {
31217     "type": "delete",
31218     "url": "/api/voice/contexts/{id}",
31219     "title": "Deletes a context",
31220     "examples": [
31221       {
31222         "title": "Example usage:",
31223         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31224         "type": "json"
31225       }
31226     ],
31227     "name": "Delete",
31228     "group": "Voice_Contexts",
31229     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31230     "version": "0.0.0",
31231     "filename": "server/api/voiceContext/index.js",
31232     "groupTitle": "Voice_Contexts"
31233   },
31234   {
31235     "type": "get",
31236     "url": "/api/voice/contexts",
31237     "title": "Gets a list of Contexts",
31238     "examples": [
31239       {
31240         "title": "Example usage:",
31241         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31242         "type": "json"
31243       }
31244     ],
31245     "name": "GetContexts",
31246     "group": "Voice_Contexts",
31247     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31248     "version": "0.0.0",
31249     "filename": "server/api/voiceContext/index.js",
31250     "groupTitle": "Voice_Contexts"
31251   },
31252   {
31253     "type": "get",
31254     "url": "/api/voice/contexts/{id}",
31255     "title": "Gets a single Context",
31256     "examples": [
31257       {
31258         "title": "Example usage:",
31259         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31260         "type": "json"
31261       }
31262     ],
31263     "name": "ShowContexts",
31264     "group": "Voice_Contexts",
31265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31266     "version": "0.0.0",
31267     "filename": "server/api/voiceContext/index.js",
31268     "groupTitle": "Voice_Contexts"
31269   },
31270   {
31271     "type": "put",
31272     "url": "/api/voice/contexts/{id}",
31273     "title": "Update an existing context",
31274     "examples": [
31275       {
31276         "title": "Example usage:",
31277         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31278         "type": "json"
31279       }
31280     ],
31281     "name": "Update",
31282     "group": "Voice_Contexts",
31283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31284     "version": "0.0.0",
31285     "filename": "server/api/voiceContext/index.js",
31286     "groupTitle": "Voice_Contexts"
31287   },
31288   {
31289     "type": "get",
31290     "url": "/api/voice/dials/reports/describe",
31291     "title": "Gets table info about Dial Reports",
31292     "examples": [
31293       {
31294         "title": "Example usage:",
31295         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31296         "type": "json"
31297       }
31298     ],
31299     "name": "DescribeDial_Reports",
31300     "group": "Voice_Dial_Reports",
31301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31302     "version": "0.0.0",
31303     "filename": "server/api/voiceDialReport/index.js",
31304     "groupTitle": "Voice_Dial_Reports"
31305   },
31306   {
31307     "type": "get",
31308     "url": "/api/voice/dials/reports",
31309     "title": "Gets a list of Dial Reports",
31310     "examples": [
31311       {
31312         "title": "Example usage:",
31313         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31314         "type": "json"
31315       }
31316     ],
31317     "name": "GetDial_Reports",
31318     "group": "Voice_Dial_Reports",
31319     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31320     "version": "0.0.0",
31321     "filename": "server/api/voiceDialReport/index.js",
31322     "groupTitle": "Voice_Dial_Reports"
31323   },
31324   {
31325     "type": "get",
31326     "url": "/api/voice/dials/reports/{id}",
31327     "title": "Gets a single Dial Report",
31328     "examples": [
31329       {
31330         "title": "Example usage:",
31331         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31332         "type": "json"
31333       }
31334     ],
31335     "name": "ShowDial_Reports",
31336     "group": "Voice_Dial_Reports",
31337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31338     "version": "0.0.0",
31339     "filename": "server/api/voiceDialReport/index.js",
31340     "groupTitle": "Voice_Dial_Reports"
31341   },
31342   {
31343     "type": "delete",
31344     "url": "/api/voice/extensions/{id}",
31345     "title": "Deletes a Extension",
31346     "examples": [
31347       {
31348         "title": "Example usage:",
31349         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31350         "type": "json"
31351       }
31352     ],
31353     "name": "DeleteExtensions",
31354     "group": "Voice_Extensions",
31355     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31356     "version": "0.0.0",
31357     "filename": "server/api/voiceExtension/index.js",
31358     "groupTitle": "Voice_Extensions"
31359   },
31360   {
31361     "type": "get",
31362     "url": "/api/voice/extensions",
31363     "title": "Gets a list of Extensions",
31364     "examples": [
31365       {
31366         "title": "Example usage:",
31367         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31368         "type": "json"
31369       }
31370     ],
31371     "name": "GetExtensions",
31372     "group": "Voice_Extensions",
31373     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31374     "version": "0.0.0",
31375     "filename": "server/api/voiceExtension/index.js",
31376     "groupTitle": "Voice_Extensions"
31377   },
31378   {
31379     "type": "get",
31380     "url": "/api/voice/extensions/{id}",
31381     "title": "Gets a single Extension",
31382     "examples": [
31383       {
31384         "title": "Example usage:",
31385         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31386         "type": "json"
31387       }
31388     ],
31389     "name": "ShowExtensions",
31390     "group": "Voice_Extensions",
31391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31392     "version": "0.0.0",
31393     "filename": "server/api/voiceExtension/index.js",
31394     "groupTitle": "Voice_Extensions"
31395   },
31396   {
31397     "type": "post",
31398     "url": "/api/voice/extensions",
31399     "title": "Create new applications",
31400     "examples": [
31401       {
31402         "title": "Example usage:",
31403         "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",
31404         "type": "json"
31405       }
31406     ],
31407     "name": "addApplications",
31408     "group": "Voice_Extensions",
31409     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31410     "version": "0.0.0",
31411     "filename": "server/api/voiceExtension/index.js",
31412     "groupTitle": "Voice_Extensions"
31413   },
31414   {
31415     "type": "post",
31416     "url": "/api/voice/extensions",
31417     "title": "Create an extension",
31418     "examples": [
31419       {
31420         "title": "Example usage:",
31421         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31422         "type": "json"
31423       }
31424     ],
31425     "name": "create",
31426     "group": "Voice_Extensions",
31427     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31428     "version": "0.0.0",
31429     "filename": "server/api/voiceExtension/index.js",
31430     "groupTitle": "Voice_Extensions"
31431   },
31432   {
31433     "type": "put",
31434     "url": "/api/voice/extensions/{id}",
31435     "title": "Update an extension",
31436     "examples": [
31437       {
31438         "title": "Example usage:",
31439         "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",
31440         "type": "json"
31441       }
31442     ],
31443     "name": "update",
31444     "group": "Voice_Extensions",
31445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31446     "version": "0.0.0",
31447     "filename": "server/api/voiceExtension/index.js",
31448     "groupTitle": "Voice_Extensions"
31449   },
31450   {
31451     "type": "post",
31452     "url": "/api/voice/mohs",
31453     "title": "Create a new a new MOH",
31454     "examples": [
31455       {
31456         "title": "Example usage:",
31457         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31458         "type": "json"
31459       }
31460     ],
31461     "name": "AddMoh",
31462     "group": "Voice_MOHs",
31463     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31464     "version": "0.0.0",
31465     "filename": "server/api/voiceMusicOnHold/index.js",
31466     "groupTitle": "Voice_MOHs"
31467   },
31468   {
31469     "type": "post",
31470     "url": "/api/voice/mohs/{id}/sounds",
31471     "title": "Add sound to MOH",
31472     "examples": [
31473       {
31474         "title": "Example usage:",
31475         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31476         "type": "json"
31477       }
31478     ],
31479     "name": "AddSound",
31480     "group": "Voice_MOHs",
31481     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31482     "version": "0.0.0",
31483     "filename": "server/api/voiceMusicOnHold/index.js",
31484     "groupTitle": "Voice_MOHs"
31485   },
31486   {
31487     "type": "delete",
31488     "url": "/api/voice/mohs/{id}",
31489     "title": "Deletes an MOH",
31490     "examples": [
31491       {
31492         "title": "Example usage:",
31493         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31494         "type": "json"
31495       }
31496     ],
31497     "name": "DestroyMoh",
31498     "group": "Voice_MOHs",
31499     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31500     "version": "0.0.0",
31501     "filename": "server/api/voiceMusicOnHold/index.js",
31502     "groupTitle": "Voice_MOHs"
31503   },
31504   {
31505     "type": "get",
31506     "url": "/api/voice/mohs",
31507     "title": "Gets a list of Music On Holds",
31508     "examples": [
31509       {
31510         "title": "Example usage:",
31511         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31512         "type": "json"
31513       }
31514     ],
31515     "name": "GetMusic_On_Holds",
31516     "group": "Voice_MOHs",
31517     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31518     "version": "0.0.0",
31519     "filename": "server/api/voiceMusicOnHold/index.js",
31520     "groupTitle": "Voice_MOHs"
31521   },
31522   {
31523     "type": "get",
31524     "url": "/api/voice/mohs/{id}/sounds",
31525     "title": "Gets sounds from MOH",
31526     "examples": [
31527       {
31528         "title": "Example usage:",
31529         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31530         "type": "json"
31531       }
31532     ],
31533     "name": "GetSounds",
31534     "group": "Voice_MOHs",
31535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31536     "version": "0.0.0",
31537     "filename": "server/api/voiceMusicOnHold/index.js",
31538     "groupTitle": "Voice_MOHs"
31539   },
31540   {
31541     "type": "delete",
31542     "url": "/api/voice/mohs/{id}/sounds/{id2}",
31543     "title": "Remove sound from MOH",
31544     "examples": [
31545       {
31546         "title": "Example usage:",
31547         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31548         "type": "json"
31549       }
31550     ],
31551     "name": "RemoveSound",
31552     "group": "Voice_MOHs",
31553     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31554     "version": "0.0.0",
31555     "filename": "server/api/voiceMusicOnHold/index.js",
31556     "groupTitle": "Voice_MOHs"
31557   },
31558   {
31559     "type": "get",
31560     "url": "/api/voice/mohs/{id}",
31561     "title": "Gets a single Music On Hold",
31562     "examples": [
31563       {
31564         "title": "Example usage:",
31565         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31566         "type": "json"
31567       }
31568     ],
31569     "name": "ShowMusic_On_Holds",
31570     "group": "Voice_MOHs",
31571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31572     "version": "0.0.0",
31573     "filename": "server/api/voiceMusicOnHold/index.js",
31574     "groupTitle": "Voice_MOHs"
31575   },
31576   {
31577     "type": "put",
31578     "url": "/api/voice/mohs/{id}",
31579     "title": "Update an existing Music On Hold",
31580     "examples": [
31581       {
31582         "title": "Example usage:",
31583         "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",
31584         "type": "json"
31585       }
31586     ],
31587     "name": "updateMusic_On_Holds",
31588     "group": "Voice_MOHs",
31589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31590     "version": "0.0.0",
31591     "filename": "server/api/voiceMusicOnHold/index.js",
31592     "groupTitle": "Voice_MOHs"
31593   },
31594   {
31595     "type": "post",
31596     "url": "/api/voice/mails",
31597     "title": "Creates a new Mail",
31598     "examples": [
31599       {
31600         "title": "Example usage:",
31601         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31602         "type": "json"
31603       }
31604     ],
31605     "name": "CreateMails",
31606     "group": "Voice_Mails",
31607     "parameter": {
31608       "fields": {
31609         "Body": [
31610           {
31611             "group": "Body",
31612             "type": "String",
31613             "optional": true,
31614             "field": "customer_id",
31615             "description": ""
31616           },
31617           {
31618             "group": "Body",
31619             "type": "String",
31620             "optional": true,
31621             "field": "context",
31622             "description": ""
31623           },
31624           {
31625             "group": "Body",
31626             "type": "String",
31627             "optional": false,
31628             "field": "mailbox",
31629             "description": ""
31630           },
31631           {
31632             "group": "Body",
31633             "type": "String",
31634             "optional": true,
31635             "field": "password",
31636             "description": ""
31637           },
31638           {
31639             "group": "Body",
31640             "type": "String",
31641             "optional": true,
31642             "field": "fullname",
31643             "description": ""
31644           },
31645           {
31646             "group": "Body",
31647             "type": "String",
31648             "optional": true,
31649             "field": "email",
31650             "description": ""
31651           },
31652           {
31653             "group": "Body",
31654             "type": "String",
31655             "optional": true,
31656             "field": "pager",
31657             "description": ""
31658           },
31659           {
31660             "group": "Body",
31661             "type": "String",
31662             "optional": true,
31663             "field": "tz",
31664             "description": ""
31665           },
31666           {
31667             "group": "Body",
31668             "type": "String",
31669             "allowedValues": [
31670               "\"yes\"",
31671               "\"no\""
31672             ],
31673             "optional": false,
31674             "field": "attach",
31675             "description": ""
31676           },
31677           {
31678             "group": "Body",
31679             "type": "String",
31680             "allowedValues": [
31681               "\"yes\"",
31682               "\"no\""
31683             ],
31684             "optional": false,
31685             "field": "saycid",
31686             "description": ""
31687           },
31688           {
31689             "group": "Body",
31690             "type": "String",
31691             "optional": true,
31692             "field": "dialout",
31693             "description": ""
31694           },
31695           {
31696             "group": "Body",
31697             "type": "String",
31698             "optional": true,
31699             "field": "callback",
31700             "description": ""
31701           },
31702           {
31703             "group": "Body",
31704             "type": "String",
31705             "allowedValues": [
31706               "\"yes\"",
31707               "\"no\""
31708             ],
31709             "optional": false,
31710             "field": "review",
31711             "description": ""
31712           },
31713           {
31714             "group": "Body",
31715             "type": "String",
31716             "allowedValues": [
31717               "\"yes\"",
31718               "\"no\""
31719             ],
31720             "optional": false,
31721             "field": "operator",
31722             "description": ""
31723           },
31724           {
31725             "group": "Body",
31726             "type": "String",
31727             "allowedValues": [
31728               "\"yes\"",
31729               "\"no\""
31730             ],
31731             "optional": false,
31732             "field": "envelope",
31733             "description": ""
31734           },
31735           {
31736             "group": "Body",
31737             "type": "String",
31738             "allowedValues": [
31739               "\"yes\"",
31740               "\"no\""
31741             ],
31742             "optional": false,
31743             "field": "sayduration",
31744             "description": ""
31745           },
31746           {
31747             "group": "Body",
31748             "type": "String",
31749             "optional": false,
31750             "field": "saydurationm",
31751             "description": ""
31752           },
31753           {
31754             "group": "Body",
31755             "type": "String",
31756             "allowedValues": [
31757               "\"yes\"",
31758               "\"no\""
31759             ],
31760             "optional": false,
31761             "field": "sendvoicemail",
31762             "description": ""
31763           },
31764           {
31765             "group": "Body",
31766             "type": "String",
31767             "allowedValues": [
31768               "\"yes\"",
31769               "\"no\""
31770             ],
31771             "optional": false,
31772             "field": "delete",
31773             "description": ""
31774           },
31775           {
31776             "group": "Body",
31777             "type": "String",
31778             "allowedValues": [
31779               "\"yes\"",
31780               "\"no\""
31781             ],
31782             "optional": false,
31783             "field": "nextaftercmd",
31784             "description": ""
31785           },
31786           {
31787             "group": "Body",
31788             "type": "String",
31789             "allowedValues": [
31790               "\"yes\"",
31791               "\"no\""
31792             ],
31793             "optional": false,
31794             "field": "forcename",
31795             "description": ""
31796           },
31797           {
31798             "group": "Body",
31799             "type": "String",
31800             "allowedValues": [
31801               "\"yes\"",
31802               "\"no\""
31803             ],
31804             "optional": false,
31805             "field": "forcegreetings",
31806             "description": ""
31807           },
31808           {
31809             "group": "Body",
31810             "type": "String",
31811             "allowedValues": [
31812               "\"yes\"",
31813               "\"no\""
31814             ],
31815             "optional": false,
31816             "field": "hidefromdir",
31817             "description": ""
31818           },
31819           {
31820             "group": "Body",
31821             "type": "String",
31822             "optional": true,
31823             "field": "stamp",
31824             "description": ""
31825           },
31826           {
31827             "group": "Body",
31828             "type": "String",
31829             "optional": true,
31830             "field": "emailsubject",
31831             "description": ""
31832           },
31833           {
31834             "group": "Body",
31835             "type": "String",
31836             "optional": true,
31837             "field": "emailbody",
31838             "description": ""
31839           },
31840           {
31841             "group": "Body",
31842             "type": "Integer",
31843             "optional": false,
31844             "field": "maxsecs",
31845             "description": ""
31846           },
31847           {
31848             "group": "Body",
31849             "type": "Integer",
31850             "optional": false,
31851             "field": "maxmsg",
31852             "description": ""
31853           },
31854           {
31855             "group": "Body",
31856             "type": "Virtual",
31857             "optional": true,
31858             "field": "name",
31859             "description": ""
31860           }
31861         ]
31862       }
31863     },
31864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31865     "version": "0.0.0",
31866     "filename": "server/api/voiceMail/index.js",
31867     "groupTitle": "Voice_Mails"
31868   },
31869   {
31870     "type": "delete",
31871     "url": "/api/voice/mails/{id}",
31872     "title": "Deletes a Mail",
31873     "examples": [
31874       {
31875         "title": "Example usage:",
31876         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31877         "type": "json"
31878       }
31879     ],
31880     "name": "DeleteMails",
31881     "group": "Voice_Mails",
31882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31883     "version": "0.0.0",
31884     "filename": "server/api/voiceMail/index.js",
31885     "groupTitle": "Voice_Mails"
31886   },
31887   {
31888     "type": "get",
31889     "url": "/api/voice/mails",
31890     "title": "Gets a list of Mails",
31891     "examples": [
31892       {
31893         "title": "Example usage:",
31894         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31895         "type": "json"
31896       }
31897     ],
31898     "name": "GetMails",
31899     "group": "Voice_Mails",
31900     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31901     "version": "0.0.0",
31902     "filename": "server/api/voiceMail/index.js",
31903     "groupTitle": "Voice_Mails"
31904   },
31905   {
31906     "type": "get",
31907     "url": "/api/voice/mails/{id}",
31908     "title": "Gets a single Mail",
31909     "examples": [
31910       {
31911         "title": "Example usage:",
31912         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31913         "type": "json"
31914       }
31915     ],
31916     "name": "ShowMails",
31917     "group": "Voice_Mails",
31918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31919     "version": "0.0.0",
31920     "filename": "server/api/voiceMail/index.js",
31921     "groupTitle": "Voice_Mails"
31922   },
31923   {
31924     "type": "get",
31925     "url": "/api/voice/mails/{id}/messages",
31926     "title": "Gets voice mail messages",
31927     "examples": [
31928       {
31929         "title": "Example usage:",
31930         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31931         "type": "json"
31932       }
31933     ],
31934     "name": "getMessages",
31935     "group": "Voice_Mails",
31936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31937     "version": "0.0.0",
31938     "filename": "server/api/voiceMail/index.js",
31939     "groupTitle": "Voice_Mails"
31940   },
31941   {
31942     "type": "put",
31943     "url": "/api/voice/mails/{id}",
31944     "title": "Update an existing Mail",
31945     "examples": [
31946       {
31947         "title": "Example usage:",
31948         "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",
31949         "type": "json"
31950       }
31951     ],
31952     "name": "updateMails",
31953     "group": "Voice_Mails",
31954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31955     "version": "0.0.0",
31956     "filename": "server/api/voiceMail/index.js",
31957     "groupTitle": "Voice_Mails"
31958   },
31959   {
31960     "type": "post",
31961     "url": "/api/voice/mails/messages",
31962     "title": "Creates a new Message",
31963     "examples": [
31964       {
31965         "title": "Example usage:",
31966         "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",
31967         "type": "json"
31968       }
31969     ],
31970     "name": "CreateMessages",
31971     "group": "Voice_Messages",
31972     "parameter": {
31973       "fields": {
31974         "Body": [
31975           {
31976             "group": "Body",
31977             "type": "Virtual",
31978             "optional": true,
31979             "field": "name",
31980             "description": ""
31981           },
31982           {
31983             "group": "Body",
31984             "type": "Integer",
31985             "optional": false,
31986             "field": "msgnum",
31987             "description": ""
31988           },
31989           {
31990             "group": "Body",
31991             "type": "String",
31992             "optional": true,
31993             "field": "dir",
31994             "description": ""
31995           },
31996           {
31997             "group": "Body",
31998             "type": "String",
31999             "optional": true,
32000             "field": "context",
32001             "description": ""
32002           },
32003           {
32004             "group": "Body",
32005             "type": "String",
32006             "optional": true,
32007             "field": "macrocontext",
32008             "description": ""
32009           },
32010           {
32011             "group": "Body",
32012             "type": "String",
32013             "optional": true,
32014             "field": "callerid",
32015             "description": ""
32016           },
32017           {
32018             "group": "Body",
32019             "type": "String",
32020             "optional": true,
32021             "field": "origtime",
32022             "description": ""
32023           },
32024           {
32025             "group": "Body",
32026             "type": "String",
32027             "optional": true,
32028             "field": "duration",
32029             "description": ""
32030           },
32031           {
32032             "group": "Body",
32033             "type": "String",
32034             "optional": true,
32035             "field": "mailboxuser",
32036             "description": ""
32037           },
32038           {
32039             "group": "Body",
32040             "type": "String",
32041             "optional": true,
32042             "field": "mailboxcontext",
32043             "description": ""
32044           },
32045           {
32046             "group": "Body",
32047             "type": "Blob",
32048             "optional": true,
32049             "field": "recording",
32050             "description": ""
32051           },
32052           {
32053             "group": "Body",
32054             "type": "String",
32055             "optional": true,
32056             "field": "flag",
32057             "description": ""
32058           },
32059           {
32060             "group": "Body",
32061             "type": "String",
32062             "optional": true,
32063             "field": "msg_id",
32064             "description": ""
32065           },
32066           {
32067             "group": "Body",
32068             "type": "String",
32069             "optional": true,
32070             "field": "stamp",
32071             "description": ""
32072           }
32073         ]
32074       }
32075     },
32076     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32077     "version": "0.0.0",
32078     "filename": "server/api/voiceMailMessage/index.js",
32079     "groupTitle": "Voice_Messages"
32080   },
32081   {
32082     "type": "delete",
32083     "url": "/api/voice/mails/messages/{id}",
32084     "title": "Deletes a Message",
32085     "examples": [
32086       {
32087         "title": "Example usage:",
32088         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
32089         "type": "json"
32090       }
32091     ],
32092     "name": "DeleteMessages",
32093     "group": "Voice_Messages",
32094     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32095     "version": "0.0.0",
32096     "filename": "server/api/voiceMailMessage/index.js",
32097     "groupTitle": "Voice_Messages"
32098   },
32099   {
32100     "type": "get",
32101     "url": "/api/voice/mails/messages",
32102     "title": "Gets a list of Messages",
32103     "examples": [
32104       {
32105         "title": "Example usage:",
32106         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32107         "type": "json"
32108       }
32109     ],
32110     "name": "GetMessages",
32111     "group": "Voice_Messages",
32112     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32113     "version": "0.0.0",
32114     "filename": "server/api/voiceMailMessage/index.js",
32115     "groupTitle": "Voice_Messages"
32116   },
32117   {
32118     "type": "get",
32119     "url": "/api/voice/mails/messages/{id}",
32120     "title": "Gets a single Message",
32121     "examples": [
32122       {
32123         "title": "Example usage:",
32124         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32125         "type": "json"
32126       }
32127     ],
32128     "name": "ShowMessages",
32129     "group": "Voice_Messages",
32130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32131     "version": "0.0.0",
32132     "filename": "server/api/voiceMailMessage/index.js",
32133     "groupTitle": "Voice_Messages"
32134   },
32135   {
32136     "type": "get",
32137     "url": "voice/mails/messages/{id}/download",
32138     "title": "Download Voice Message",
32139     "examples": [
32140       {
32141         "title": "Example usage:",
32142         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32143         "type": "json"
32144       }
32145     ],
32146     "name": "download",
32147     "group": "Voice_Messages",
32148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32149     "version": "0.0.0",
32150     "filename": "server/api/voiceMailMessage/index.js",
32151     "groupTitle": "Voice_Messages"
32152   },
32153   {
32154     "type": "put",
32155     "url": "/api/voice/mails/messages/{id}",
32156     "title": "Update an existing Message",
32157     "examples": [
32158       {
32159         "title": "Example usage:",
32160         "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",
32161         "type": "json"
32162       }
32163     ],
32164     "name": "updateMessages",
32165     "group": "Voice_Messages",
32166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32167     "version": "0.0.0",
32168     "filename": "server/api/voiceMailMessage/index.js",
32169     "groupTitle": "Voice_Messages"
32170   },
32171   {
32172     "type": "post",
32173     "url": "/api/voice/prefixes/{id}/teams",
32174     "title": "Add teams to voice prefix",
32175     "examples": [
32176       {
32177         "title": "Example usage:",
32178         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32179         "type": "json"
32180       }
32181     ],
32182     "name": "AddTeams",
32183     "group": "Voice_Prefix",
32184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32185     "version": "0.0.0",
32186     "filename": "server/api/voicePrefix/index.js",
32187     "groupTitle": "Voice_Prefix"
32188   },
32189   {
32190     "type": "get",
32191     "url": "/api/voice/prefixes/{id}/teams",
32192     "title": "Gets voice prefix team",
32193     "examples": [
32194       {
32195         "title": "Example usage:",
32196         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
32197         "type": "json"
32198       }
32199     ],
32200     "name": "GetTeams",
32201     "group": "Voice_Prefix",
32202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32203     "version": "0.0.0",
32204     "filename": "server/api/voicePrefix/index.js",
32205     "groupTitle": "Voice_Prefix"
32206   },
32207   {
32208     "type": "post",
32209     "url": "/api/voice/prefixes/{id}/users",
32210     "title": "Add agents to a prefix",
32211     "examples": [
32212       {
32213         "title": "Example usage:",
32214         "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",
32215         "type": "json"
32216       }
32217     ],
32218     "name": "AddAgents",
32219     "group": "Voice_Prefixes",
32220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32221     "version": "0.0.0",
32222     "filename": "server/api/voicePrefix/index.js",
32223     "groupTitle": "Voice_Prefixes"
32224   },
32225   {
32226     "type": "delete",
32227     "url": "/api/voice/prefixes/{id}",
32228     "title": "Deletes a Prefix",
32229     "examples": [
32230       {
32231         "title": "Example usage:",
32232         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32233         "type": "json"
32234       }
32235     ],
32236     "name": "DeletePrefixes",
32237     "group": "Voice_Prefixes",
32238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32239     "version": "0.0.0",
32240     "filename": "server/api/voicePrefix/index.js",
32241     "groupTitle": "Voice_Prefixes"
32242   },
32243   {
32244     "type": "get",
32245     "url": "/api/voice/prefixes/describe",
32246     "title": "Gets table info about Prefixes",
32247     "examples": [
32248       {
32249         "title": "Example usage:",
32250         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32251         "type": "json"
32252       }
32253     ],
32254     "name": "DescribePrefixes",
32255     "group": "Voice_Prefixes",
32256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32257     "version": "0.0.0",
32258     "filename": "server/api/voicePrefix/index.js",
32259     "groupTitle": "Voice_Prefixes"
32260   },
32261   {
32262     "type": "get",
32263     "url": "/api/voice/prefixes/{id}/users",
32264     "title": "Gets agents from prefix",
32265     "examples": [
32266       {
32267         "title": "Example usage:",
32268         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32269         "type": "json"
32270       }
32271     ],
32272     "name": "GetAgents",
32273     "group": "Voice_Prefixes",
32274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32275     "version": "0.0.0",
32276     "filename": "server/api/voicePrefix/index.js",
32277     "groupTitle": "Voice_Prefixes"
32278   },
32279   {
32280     "type": "get",
32281     "url": "/api/voice/prefixes",
32282     "title": "Gets a list of Prefixes",
32283     "examples": [
32284       {
32285         "title": "Example usage:",
32286         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32287         "type": "json"
32288       }
32289     ],
32290     "name": "GetPrefixes",
32291     "group": "Voice_Prefixes",
32292     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32293     "version": "0.0.0",
32294     "filename": "server/api/voicePrefix/index.js",
32295     "groupTitle": "Voice_Prefixes"
32296   },
32297   {
32298     "type": "delete",
32299     "url": "/api/voice/prefixes/{id}/users",
32300     "title": "Removes agents from a prefix",
32301     "examples": [
32302       {
32303         "title": "Example usage:",
32304         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32305         "type": "json"
32306       }
32307     ],
32308     "name": "RemoveAgents",
32309     "group": "Voice_Prefixes",
32310     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32311     "version": "0.0.0",
32312     "filename": "server/api/voicePrefix/index.js",
32313     "groupTitle": "Voice_Prefixes"
32314   },
32315   {
32316     "type": "get",
32317     "url": "/api/voice/prefixes/{id}",
32318     "title": "Gets a single Prefix",
32319     "examples": [
32320       {
32321         "title": "Example usage:",
32322         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32323         "type": "json"
32324       }
32325     ],
32326     "name": "ShowPrefixes",
32327     "group": "Voice_Prefixes",
32328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32329     "version": "0.0.0",
32330     "filename": "server/api/voicePrefix/index.js",
32331     "groupTitle": "Voice_Prefixes"
32332   },
32333   {
32334     "type": "put",
32335     "url": "/api/voice/prefixes/{id}",
32336     "title": "Update an existing prefix",
32337     "examples": [
32338       {
32339         "title": "Example usage:",
32340         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32341         "type": "json"
32342       }
32343     ],
32344     "name": "Update",
32345     "group": "Voice_Prefixes",
32346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32347     "version": "0.0.0",
32348     "filename": "server/api/voicePrefix/index.js",
32349     "groupTitle": "Voice_Prefixes"
32350   },
32351   {
32352     "type": "post",
32353     "url": "/api/voice/prefixes",
32354     "title": "Create a prefix",
32355     "examples": [
32356       {
32357         "title": "Example usage:",
32358         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32359         "type": "json"
32360       }
32361     ],
32362     "name": "create",
32363     "group": "Voice_Prefixes",
32364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32365     "version": "0.0.0",
32366     "filename": "server/api/voicePrefix/index.js",
32367     "groupTitle": "Voice_Prefixes"
32368   },
32369   {
32370     "type": "get",
32371     "url": "/api/voice/queues/reports/describe",
32372     "title": "Gets table info about Queue Reports",
32373     "examples": [
32374       {
32375         "title": "Example usage:",
32376         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32377         "type": "json"
32378       }
32379     ],
32380     "name": "DescribeQueue_Reports",
32381     "group": "Voice_Queue_Reports",
32382     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32383     "version": "0.0.0",
32384     "filename": "server/api/voiceQueueReport/index.js",
32385     "groupTitle": "Voice_Queue_Reports"
32386   },
32387   {
32388     "type": "get",
32389     "url": "/api/voice/queues/reports",
32390     "title": "Gets a list of Queue Reports",
32391     "examples": [
32392       {
32393         "title": "Example usage:",
32394         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32395         "type": "json"
32396       }
32397     ],
32398     "name": "GetQueue_Reports",
32399     "group": "Voice_Queue_Reports",
32400     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32401     "version": "0.0.0",
32402     "filename": "server/api/voiceQueueReport/index.js",
32403     "groupTitle": "Voice_Queue_Reports"
32404   },
32405   {
32406     "type": "get",
32407     "url": "/api/voice/queues/reports/{id}",
32408     "title": "Gets a single Queue Report",
32409     "examples": [
32410       {
32411         "title": "Example usage:",
32412         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32413         "type": "json"
32414       }
32415     ],
32416     "name": "ShowQueue_Reports",
32417     "group": "Voice_Queue_Reports",
32418     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32419     "version": "0.0.0",
32420     "filename": "server/api/voiceQueueReport/index.js",
32421     "groupTitle": "Voice_Queue_Reports"
32422   },
32423   {
32424     "type": "get",
32425     "url": "/api/voice/queues/reports/index",
32426     "title": "Get Voice Queues Report",
32427     "examples": [
32428       {
32429         "title": "Example usage:",
32430         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32431         "type": "json"
32432       }
32433     ],
32434     "name": "getVoiceQueuesReport",
32435     "group": "Voice_Queue_Reports",
32436     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32437     "version": "0.0.0",
32438     "filename": "server/api/voiceQueueReport/index.js",
32439     "groupTitle": "Voice_Queue_Reports"
32440   },
32441   {
32442     "type": "post",
32443     "url": "/api/voice/queues/{id}/users",
32444     "title": "Add agents to queue",
32445     "examples": [
32446       {
32447         "title": "Example usage:",
32448         "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",
32449         "type": "json"
32450       }
32451     ],
32452     "name": "AddAgents",
32453     "group": "Voice_Queues",
32454     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32455     "version": "0.0.0",
32456     "filename": "server/api/voiceQueue/index.js",
32457     "groupTitle": "Voice_Queues"
32458   },
32459   {
32460     "type": "post",
32461     "url": "/api/voice/queues/{id}/blacklists",
32462     "title": "Add blacklists to a queue",
32463     "examples": [
32464       {
32465         "title": "Example usage:",
32466         "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",
32467         "type": "json"
32468       }
32469     ],
32470     "name": "AddBlackLists",
32471     "group": "Voice_Queues",
32472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32473     "version": "0.0.0",
32474     "filename": "server/api/voiceQueue/index.js",
32475     "groupTitle": "Voice_Queues"
32476   },
32477   {
32478     "type": "post",
32479     "url": "/api/voice/queues/{id}/lists",
32480     "title": "Add lists to a queue",
32481     "examples": [
32482       {
32483         "title": "Example usage:",
32484         "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",
32485         "type": "json"
32486       }
32487     ],
32488     "name": "AddLists",
32489     "group": "Voice_Queues",
32490     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32491     "version": "0.0.0",
32492     "filename": "server/api/voiceQueue/index.js",
32493     "groupTitle": "Voice_Queues"
32494   },
32495   {
32496     "type": "post",
32497     "url": "/api/voice/queues/{id}/teams",
32498     "title": "Add teams to queue",
32499     "examples": [
32500       {
32501         "title": "Example usage:",
32502         "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",
32503         "type": "json"
32504       }
32505     ],
32506     "name": "AddTeams",
32507     "group": "Voice_Queues",
32508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32509     "version": "0.0.0",
32510     "filename": "server/api/voiceQueue/index.js",
32511     "groupTitle": "Voice_Queues"
32512   },
32513   {
32514     "type": "post",
32515     "url": "/api/voice/queues/clone",
32516     "title": "Clone an existing Queue",
32517     "examples": [
32518       {
32519         "title": "Example usage:",
32520         "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",
32521         "type": "json"
32522       }
32523     ],
32524     "name": "CloneQueues",
32525     "group": "Voice_Queues",
32526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32527     "version": "0.0.0",
32528     "filename": "server/api/voiceQueue/index.js",
32529     "groupTitle": "Voice_Queues"
32530   },
32531   {
32532     "type": "post",
32533     "url": "/api/voice/queues",
32534     "title": "Creates a new Queue",
32535     "examples": [
32536       {
32537         "title": "Example usage:",
32538         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32539         "type": "json"
32540       }
32541     ],
32542     "name": "CreateQueues",
32543     "group": "Voice_Queues",
32544     "parameter": {
32545       "fields": {
32546         "Body": [
32547           {
32548             "group": "Body",
32549             "type": "String",
32550             "optional": false,
32551             "field": "name",
32552             "description": ""
32553           },
32554           {
32555             "group": "Body",
32556             "type": "String",
32557             "allowedValues": [
32558               "\"inbound\"",
32559               "\"outbound\""
32560             ],
32561             "optional": false,
32562             "field": "type",
32563             "description": ""
32564           },
32565           {
32566             "group": "Body",
32567             "type": "String",
32568             "optional": true,
32569             "field": "musiconhold",
32570             "description": ""
32571           },
32572           {
32573             "group": "Body",
32574             "type": "String",
32575             "optional": true,
32576             "field": "announce",
32577             "description": ""
32578           },
32579           {
32580             "group": "Body",
32581             "type": "String",
32582             "allowedValues": [
32583               "\"rr\"",
32584               "\"ringall\"",
32585               "\"leastrecent\"",
32586               "\"fewestcalls\"",
32587               "\"random\"",
32588               "\"rrmemory\"",
32589               "\"linear\"",
32590               "\"wrandom\"",
32591               "\"rrordered\""
32592             ],
32593             "optional": false,
32594             "field": "strategy",
32595             "description": ""
32596           },
32597           {
32598             "group": "Body",
32599             "type": "Integer",
32600             "optional": true,
32601             "field": "servicelevel",
32602             "description": ""
32603           },
32604           {
32605             "group": "Body",
32606             "type": "String",
32607             "optional": true,
32608             "field": "context",
32609             "description": ""
32610           },
32611           {
32612             "group": "Body",
32613             "type": "Integer",
32614             "optional": true,
32615             "field": "penaltymemberslimit",
32616             "description": ""
32617           },
32618           {
32619             "group": "Body",
32620             "type": "Integer",
32621             "optional": true,
32622             "field": "timeout",
32623             "description": ""
32624           },
32625           {
32626             "group": "Body",
32627             "type": "Integer",
32628             "optional": true,
32629             "field": "retry",
32630             "description": ""
32631           },
32632           {
32633             "group": "Body",
32634             "type": "String",
32635             "optional": true,
32636             "field": "timeoutpriority",
32637             "description": ""
32638           },
32639           {
32640             "group": "Body",
32641             "type": "Integer",
32642             "optional": true,
32643             "field": "weight",
32644             "description": ""
32645           },
32646           {
32647             "group": "Body",
32648             "type": "Integer",
32649             "optional": true,
32650             "field": "wrapuptime",
32651             "description": ""
32652           },
32653           {
32654             "group": "Body",
32655             "type": "String",
32656             "allowedValues": [
32657               "\"yes\"",
32658               "\"no\""
32659             ],
32660             "optional": true,
32661             "field": "autofill",
32662             "description": ""
32663           },
32664           {
32665             "group": "Body",
32666             "type": "String",
32667             "allowedValues": [
32668               "\"yes\"",
32669               "\"no\"",
32670               "\"all\""
32671             ],
32672             "optional": true,
32673             "field": "autopause",
32674             "description": ""
32675           },
32676           {
32677             "group": "Body",
32678             "type": "Integer",
32679             "optional": true,
32680             "field": "autopausedelay",
32681             "description": ""
32682           },
32683           {
32684             "group": "Body",
32685             "type": "String",
32686             "allowedValues": [
32687               "\"yes\"",
32688               "\"no\""
32689             ],
32690             "optional": true,
32691             "field": "autopausebusy",
32692             "description": ""
32693           },
32694           {
32695             "group": "Body",
32696             "type": "String",
32697             "allowedValues": [
32698               "\"yes\"",
32699               "\"no\""
32700             ],
32701             "optional": true,
32702             "field": "autopauseunavail",
32703             "description": ""
32704           },
32705           {
32706             "group": "Body",
32707             "type": "Integer",
32708             "optional": true,
32709             "field": "maxlen",
32710             "description": ""
32711           },
32712           {
32713             "group": "Body",
32714             "type": "String",
32715             "allowedValues": [
32716               "\"yes\"",
32717               "\"no\""
32718             ],
32719             "optional": true,
32720             "field": "setinterfacevar",
32721             "description": ""
32722           },
32723           {
32724             "group": "Body",
32725             "type": "String",
32726             "allowedValues": [
32727               "\"yes\"",
32728               "\"no\""
32729             ],
32730             "optional": true,
32731             "field": "setqueueentryvar",
32732             "description": ""
32733           },
32734           {
32735             "group": "Body",
32736             "type": "String",
32737             "allowedValues": [
32738               "\"yes\"",
32739               "\"no\""
32740             ],
32741             "optional": true,
32742             "field": "setqueuevar",
32743             "description": ""
32744           },
32745           {
32746             "group": "Body",
32747             "type": "String",
32748             "allowedValues": [
32749               "\"yes\"",
32750               "\"no\""
32751             ],
32752             "optional": true,
32753             "field": "eventmemberstatus",
32754             "description": ""
32755           },
32756           {
32757             "group": "Body",
32758             "type": "String",
32759             "optional": true,
32760             "field": "membermacro",
32761             "description": ""
32762           },
32763           {
32764             "group": "Body",
32765             "type": "String",
32766             "optional": true,
32767             "field": "membergosub",
32768             "description": ""
32769           },
32770           {
32771             "group": "Body",
32772             "type": "Integer",
32773             "optional": true,
32774             "field": "announce_frequency",
32775             "description": ""
32776           },
32777           {
32778             "group": "Body",
32779             "type": "Integer",
32780             "optional": true,
32781             "field": "min_announce_frequency",
32782             "description": ""
32783           },
32784           {
32785             "group": "Body",
32786             "type": "Integer",
32787             "optional": true,
32788             "field": "periodic_announce_frequency",
32789             "description": ""
32790           },
32791           {
32792             "group": "Body",
32793             "type": "String",
32794             "allowedValues": [
32795               "\"yes\"",
32796               "\"no\""
32797             ],
32798             "optional": true,
32799             "field": "random_periodic_announce",
32800             "description": ""
32801           },
32802           {
32803             "group": "Body",
32804             "type": "String",
32805             "allowedValues": [
32806               "\"yes\"",
32807               "\"no\""
32808             ],
32809             "optional": true,
32810             "field": "relative_periodic_announce",
32811             "description": ""
32812           },
32813           {
32814             "group": "Body",
32815             "type": "String",
32816             "allowedValues": [
32817               "\"yes\"",
32818               "\"no\"",
32819               "\"once\""
32820             ],
32821             "optional": true,
32822             "field": "announce_holdtime",
32823             "description": ""
32824           },
32825           {
32826             "group": "Body",
32827             "type": "String",
32828             "optional": true,
32829             "field": "announce_position",
32830             "description": ""
32831           },
32832           {
32833             "group": "Body",
32834             "type": "String",
32835             "allowedValues": [
32836               "\"yes\"",
32837               "\"no\""
32838             ],
32839             "optional": true,
32840             "field": "announce_to_first_user",
32841             "description": ""
32842           },
32843           {
32844             "group": "Body",
32845             "type": "Integer",
32846             "optional": true,
32847             "field": "announce_position_limit",
32848             "description": ""
32849           },
32850           {
32851             "group": "Body",
32852             "type": "String",
32853             "allowedValues": [
32854               "\"0\"",
32855               "\"5\"",
32856               "\"10\"",
32857               "\"15\"",
32858               "\"20\"",
32859               "\"30\""
32860             ],
32861             "optional": true,
32862             "field": "announce_round_seconds",
32863             "description": ""
32864           },
32865           {
32866             "group": "Body",
32867             "type": "String",
32868             "optional": true,
32869             "field": "monitor_format",
32870             "description": ""
32871           },
32872           {
32873             "group": "Body",
32874             "type": "String",
32875             "optional": true,
32876             "field": "monitor_type",
32877             "description": ""
32878           },
32879           {
32880             "group": "Body",
32881             "type": "String",
32882             "optional": true,
32883             "field": "queue_youarenext",
32884             "description": ""
32885           },
32886           {
32887             "group": "Body",
32888             "type": "String",
32889             "optional": true,
32890             "field": "queue_thereare",
32891             "description": ""
32892           },
32893           {
32894             "group": "Body",
32895             "type": "String",
32896             "optional": true,
32897             "field": "queue_callswaiting",
32898             "description": ""
32899           },
32900           {
32901             "group": "Body",
32902             "type": "String",
32903             "optional": true,
32904             "field": "queue_holdtime",
32905             "description": ""
32906           },
32907           {
32908             "group": "Body",
32909             "type": "String",
32910             "optional": true,
32911             "field": "queue_minute",
32912             "description": ""
32913           },
32914           {
32915             "group": "Body",
32916             "type": "String",
32917             "optional": true,
32918             "field": "queue_minutes",
32919             "description": ""
32920           },
32921           {
32922             "group": "Body",
32923             "type": "String",
32924             "optional": true,
32925             "field": "queue_seconds",
32926             "description": ""
32927           },
32928           {
32929             "group": "Body",
32930             "type": "String",
32931             "optional": true,
32932             "field": "queue_thankyou",
32933             "description": ""
32934           },
32935           {
32936             "group": "Body",
32937             "type": "String",
32938             "optional": true,
32939             "field": "queue_reporthold",
32940             "description": ""
32941           },
32942           {
32943             "group": "Body",
32944             "type": "String",
32945             "optional": true,
32946             "field": "queue_quantity1",
32947             "description": ""
32948           },
32949           {
32950             "group": "Body",
32951             "type": "String",
32952             "optional": true,
32953             "field": "queue_quantity2",
32954             "description": ""
32955           },
32956           {
32957             "group": "Body",
32958             "type": "String",
32959             "optional": true,
32960             "field": "queue_periodic_announce",
32961             "description": ""
32962           },
32963           {
32964             "group": "Body",
32965             "type": "String",
32966             "optional": true,
32967             "field": "queue_less_than",
32968             "description": ""
32969           },
32970           {
32971             "group": "Body",
32972             "type": "Text",
32973             "optional": true,
32974             "field": "periodic_announce",
32975             "description": ""
32976           },
32977           {
32978             "group": "Body",
32979             "type": "String",
32980             "optional": true,
32981             "field": "joinempty",
32982             "description": ""
32983           },
32984           {
32985             "group": "Body",
32986             "type": "String",
32987             "optional": true,
32988             "field": "leavewhenempty",
32989             "description": ""
32990           },
32991           {
32992             "group": "Body",
32993             "type": "String",
32994             "allowedValues": [
32995               "\"yes\"",
32996               "\"no\""
32997             ],
32998             "optional": true,
32999             "field": "reportholdtime",
33000             "description": ""
33001           },
33002           {
33003             "group": "Body",
33004             "type": "String",
33005             "allowedValues": [
33006               "\"yes\"",
33007               "\"no\""
33008             ],
33009             "optional": true,
33010             "field": "ringinuse",
33011             "description": ""
33012           },
33013           {
33014             "group": "Body",
33015             "type": "Integer",
33016             "optional": true,
33017             "field": "memberdelay",
33018             "description": ""
33019           },
33020           {
33021             "group": "Body",
33022             "type": "String",
33023             "allowedValues": [
33024               "\"yes\"",
33025               "\"no\""
33026             ],
33027             "optional": true,
33028             "field": "timeoutrestart",
33029             "description": ""
33030           },
33031           {
33032             "group": "Body",
33033             "type": "String",
33034             "optional": true,
33035             "field": "defaultrule",
33036             "description": ""
33037           },
33038           {
33039             "group": "Body",
33040             "type": "String",
33041             "optional": true,
33042             "field": "description",
33043             "description": ""
33044           },
33045           {
33046             "group": "Body",
33047             "type": "Boolean",
33048             "optional": true,
33049             "field": "acw",
33050             "description": ""
33051           },
33052           {
33053             "group": "Body",
33054             "type": "Integer",
33055             "optional": true,
33056             "field": "acwTimeout",
33057             "description": ""
33058           },
33059           {
33060             "group": "Body",
33061             "type": "Boolean",
33062             "optional": true,
33063             "field": "dialActive",
33064             "description": "<p>Active/Disactive Campaign</p>"
33065           },
33066           {
33067             "group": "Body",
33068             "type": "String",
33069             "allowedValues": [
33070               "\"preview\"",
33071               "\"progressive\"",
33072               "\"power\"",
33073               "\"predictive\"",
33074               "\"booked\""
33075             ],
33076             "optional": true,
33077             "field": "dialMethod",
33078             "description": "<p>Dial Method.</p>"
33079           },
33080           {
33081             "group": "Body",
33082             "type": "Integer",
33083             "optional": true,
33084             "field": "dialLimitChannel",
33085             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
33086           },
33087           {
33088             "group": "Body",
33089             "type": "Integer",
33090             "optional": true,
33091             "field": "dialLimitQueue",
33092             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
33093           },
33094           {
33095             "group": "Body",
33096             "type": "Float",
33097             "optional": true,
33098             "field": "dialPowerLevel",
33099             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33100           },
33101           {
33102             "group": "Body",
33103             "type": "String",
33104             "allowedValues": [
33105               "\"agentBusyFactor\"",
33106               "\"dropRate\""
33107             ],
33108             "optional": true,
33109             "field": "dialPredictiveOptimization",
33110             "description": "<p>Only for predictive method.</p>"
33111           },
33112           {
33113             "group": "Body",
33114             "type": "Float",
33115             "optional": true,
33116             "field": "dialPredictiveOptimizationPercentage",
33117             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33118           },
33119           {
33120             "group": "Body",
33121             "type": "Integer",
33122             "optional": true,
33123             "field": "dialPredictiveInterval",
33124             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33125           },
33126           {
33127             "group": "Body",
33128             "type": "String",
33129             "optional": true,
33130             "field": "dialOriginateCallerIdName",
33131             "description": ""
33132           },
33133           {
33134             "group": "Body",
33135             "type": "String",
33136             "optional": true,
33137             "field": "dialOriginateCallerIdNumber",
33138             "description": ""
33139           },
33140           {
33141             "group": "Body",
33142             "type": "Integer",
33143             "optional": true,
33144             "field": "dialOriginateTimeout",
33145             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33146           },
33147           {
33148             "group": "Body",
33149             "type": "String",
33150             "optional": true,
33151             "field": "dialQueueOptions",
33152             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33153           },
33154           {
33155             "group": "Body",
33156             "type": "Integer",
33157             "optional": true,
33158             "field": "dialQueueTimeout",
33159             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33160           },
33161           {
33162             "group": "Body",
33163             "type": "String",
33164             "optional": true,
33165             "field": "dialQueueProject",
33166             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33167           },
33168           {
33169             "group": "Body",
33170             "type": "Integer",
33171             "optional": true,
33172             "field": "dialCongestionMaxRetry",
33173             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33174           },
33175           {
33176             "group": "Body",
33177             "type": "Integer",
33178             "optional": true,
33179             "field": "dialCongestionRetryFrequency",
33180             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33181           },
33182           {
33183             "group": "Body",
33184             "type": "Integer",
33185             "optional": true,
33186             "field": "dialBusyMaxRetry",
33187             "description": "<p>#Busy Retry (min:1, max:999)</p>"
33188           },
33189           {
33190             "group": "Body",
33191             "type": "Integer",
33192             "optional": true,
33193             "field": "dialBusyRetryFrequency",
33194             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33195           },
33196           {
33197             "group": "Body",
33198             "type": "Integer",
33199             "optional": true,
33200             "field": "dialNoAnswerMaxRetry",
33201             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33202           },
33203           {
33204             "group": "Body",
33205             "type": "Integer",
33206             "optional": true,
33207             "field": "dialNoAnswerRetryFrequency",
33208             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33209           },
33210           {
33211             "group": "Body",
33212             "type": "Integer",
33213             "optional": true,
33214             "field": "dialGlobalMaxRetry",
33215             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33216           },
33217           {
33218             "group": "Body",
33219             "type": "String",
33220             "optional": true,
33221             "field": "dialTimezone",
33222             "description": ""
33223           },
33224           {
33225             "group": "Body",
33226             "type": "String",
33227             "optional": true,
33228             "field": "dialGlobalInterval",
33229             "description": ""
33230           },
33231           {
33232             "group": "Body",
33233             "type": "String",
33234             "optional": true,
33235             "field": "dialPrefix",
33236             "description": ""
33237           },
33238           {
33239             "group": "Body",
33240             "type": "String",
33241             "allowedValues": [
33242               "\"always\"",
33243               "\"never\"",
33244               "\"onlyIfOpen\""
33245             ],
33246             "optional": true,
33247             "field": "dialCheckDuplicateType",
33248             "description": ""
33249           },
33250           {
33251             "group": "Body",
33252             "type": "Boolean",
33253             "optional": true,
33254             "field": "dialAMDActive",
33255             "description": "<p>Active/Disactive AMD</p>"
33256           },
33257           {
33258             "group": "Body",
33259             "type": "Integer",
33260             "optional": true,
33261             "field": "dialAMDInitialSilence",
33262             "description": "<p>#AMD Initial Silence</p>"
33263           },
33264           {
33265             "group": "Body",
33266             "type": "Integer",
33267             "optional": true,
33268             "field": "dialAMDGreeting",
33269             "description": "<p>#AMD Greeting</p>"
33270           },
33271           {
33272             "group": "Body",
33273             "type": "Integer",
33274             "optional": true,
33275             "field": "dialAMDAfterGreetingSilence",
33276             "description": "<p>#AMD After Greeting Silence</p>"
33277           },
33278           {
33279             "group": "Body",
33280             "type": "Integer",
33281             "optional": true,
33282             "field": "dialAMDTotalAnalysisTime",
33283             "description": "<p>#AMD Total Analysis Time</p>"
33284           },
33285           {
33286             "group": "Body",
33287             "type": "Integer",
33288             "optional": true,
33289             "field": "dialAMDMinWordLength",
33290             "description": "<p>#AMD Min Word Length</p>"
33291           },
33292           {
33293             "group": "Body",
33294             "type": "Integer",
33295             "optional": true,
33296             "field": "dialAMDBetweenWordsSilence",
33297             "description": "<p>#AMD Between Words Silence</p>"
33298           },
33299           {
33300             "group": "Body",
33301             "type": "Integer",
33302             "optional": true,
33303             "field": "dialAMDMaximumNumberOfWords",
33304             "description": "<p>#AMD Maximum Number Of Words</p>"
33305           },
33306           {
33307             "group": "Body",
33308             "type": "Integer",
33309             "optional": true,
33310             "field": "dialAMDSilenceThreshold",
33311             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33312           },
33313           {
33314             "group": "Body",
33315             "type": "Integer",
33316             "optional": true,
33317             "field": "dialAMDMaximumWordLength",
33318             "description": "<p>#AMD Maximum Word Length</p>"
33319           },
33320           {
33321             "group": "Body",
33322             "type": "Integer",
33323             "optional": true,
33324             "field": "dialRecallMeTimeout",
33325             "description": "<p>#RecallMe Timeout (min:1)</p>"
33326           },
33327           {
33328             "group": "Body",
33329             "type": "Boolean",
33330             "optional": true,
33331             "field": "dialRecallInQueue",
33332             "description": "<p>Active/Disactive Recall In Queue</p>"
33333           },
33334           {
33335             "group": "Body",
33336             "type": "String",
33337             "allowedValues": [
33338               "\"DESC\"",
33339               "\"ASC\""
33340             ],
33341             "optional": true,
33342             "field": "dialOrderByScheduledAt",
33343             "description": ""
33344           },
33345           {
33346             "group": "Body",
33347             "type": "String",
33348             "optional": true,
33349             "field": "dialQueueProject2",
33350             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33351           },
33352           {
33353             "group": "Body",
33354             "type": "Boolean",
33355             "optional": true,
33356             "field": "dialAgiAfterHangupClient",
33357             "description": ""
33358           },
33359           {
33360             "group": "Body",
33361             "type": "Boolean",
33362             "optional": true,
33363             "field": "dialAgiAfterHangupAgent",
33364             "description": ""
33365           },
33366           {
33367             "group": "Body",
33368             "type": "Integer",
33369             "optional": true,
33370             "field": "dialRandomLastDigitCallerIdNumber",
33371             "description": "<p>Random Last Digit (min:1, max:15)</p>"
33372           },
33373           {
33374             "group": "Body",
33375             "type": "Integer",
33376             "optional": true,
33377             "field": "dialCutDigit",
33378             "description": "<p>Cut Digit (min:1, max:15)</p>"
33379           },
33380           {
33381             "group": "Body",
33382             "type": "Integer",
33383             "optional": true,
33384             "field": "dialNoSuchNumberMaxRetry",
33385             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33386           },
33387           {
33388             "group": "Body",
33389             "type": "Integer",
33390             "optional": true,
33391             "field": "dialNoSuchNumberRetryFrequency",
33392             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33393           },
33394           {
33395             "group": "Body",
33396             "type": "Integer",
33397             "optional": true,
33398             "field": "dialDropMaxRetry",
33399             "description": "<p>#Drop Retry (min:1, max:999)</p>"
33400           },
33401           {
33402             "group": "Body",
33403             "type": "Integer",
33404             "optional": true,
33405             "field": "dialDropRetryFrequency",
33406             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33407           },
33408           {
33409             "group": "Body",
33410             "type": "Integer",
33411             "optional": true,
33412             "field": "dialAbandonedMaxRetry",
33413             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33414           },
33415           {
33416             "group": "Body",
33417             "type": "Integer",
33418             "optional": true,
33419             "field": "dialAbandonedRetryFrequency",
33420             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33421           },
33422           {
33423             "group": "Body",
33424             "type": "Integer",
33425             "optional": true,
33426             "field": "dialMachineMaxRetry",
33427             "description": "<p>#Machine Retry (min:1, max:999)</p>"
33428           },
33429           {
33430             "group": "Body",
33431             "type": "Integer",
33432             "optional": true,
33433             "field": "dialMachineRetryFrequency",
33434             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33435           },
33436           {
33437             "group": "Body",
33438             "type": "Integer",
33439             "optional": true,
33440             "field": "dialAgentRejectMaxRetry",
33441             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33442           },
33443           {
33444             "group": "Body",
33445             "type": "Integer",
33446             "optional": true,
33447             "field": "dialAgentRejectRetryFrequency",
33448             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33449           },
33450           {
33451             "group": "Body",
33452             "type": "Integer",
33453             "optional": true,
33454             "field": "mandatoryDispositionPauseId",
33455             "description": "<p>Status to put when mandatory disposition is enabled</p>"
33456           },
33457           {
33458             "group": "Body",
33459             "type": "Boolean",
33460             "optional": true,
33461             "field": "mandatoryDisposition",
33462             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33463           },
33464           {
33465             "group": "Body",
33466             "type": "Integer",
33467             "optional": true,
33468             "field": "dialPredictiveIntervalMaxThreshold",
33469             "description": ""
33470           },
33471           {
33472             "group": "Body",
33473             "type": "Integer",
33474             "optional": true,
33475             "field": "dialPredictiveIntervalMinThreshold",
33476             "description": ""
33477           },
33478           {
33479             "group": "Body",
33480             "type": "Boolean",
33481             "optional": true,
33482             "field": "dialPreviewAutoRecallMe",
33483             "description": ""
33484           }
33485         ]
33486       }
33487     },
33488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33489     "version": "0.0.0",
33490     "filename": "server/api/voiceQueue/index.js",
33491     "groupTitle": "Voice_Queues"
33492   },
33493   {
33494     "type": "delete",
33495     "url": "/api/voice/queues/{id}",
33496     "title": "Deletes a Queue",
33497     "examples": [
33498       {
33499         "title": "Example usage:",
33500         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33501         "type": "json"
33502       }
33503     ],
33504     "name": "DeleteQueues",
33505     "group": "Voice_Queues",
33506     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33507     "version": "0.0.0",
33508     "filename": "server/api/voiceQueue/index.js",
33509     "groupTitle": "Voice_Queues"
33510   },
33511   {
33512     "type": "get",
33513     "url": "/api/voice/queues/{id}/users",
33514     "title": "Gets queue agents",
33515     "examples": [
33516       {
33517         "title": "Example usage:",
33518         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33519         "type": "json"
33520       }
33521     ],
33522     "name": "GetAgents",
33523     "group": "Voice_Queues",
33524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33525     "version": "0.0.0",
33526     "filename": "server/api/voiceQueue/index.js",
33527     "groupTitle": "Voice_Queues"
33528   },
33529   {
33530     "type": "get",
33531     "url": "/api/voice/queues/{id}/blacklists",
33532     "title": "Get queue blacklists",
33533     "examples": [
33534       {
33535         "title": "Example usage:",
33536         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33537         "type": "json"
33538       }
33539     ],
33540     "name": "GetBlackLists",
33541     "group": "Voice_Queues",
33542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33543     "version": "0.0.0",
33544     "filename": "server/api/voiceQueue/index.js",
33545     "groupTitle": "Voice_Queues"
33546   },
33547   {
33548     "type": "get",
33549     "url": "/api/voice/queues/{id}/finals",
33550     "title": "Gets queue hopper finals",
33551     "examples": [
33552       {
33553         "title": "Example usage:",
33554         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
33555         "type": "json"
33556       }
33557     ],
33558     "name": "GetHopperFinals",
33559     "group": "Voice_Queues",
33560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33561     "version": "0.0.0",
33562     "filename": "server/api/voiceQueue/index.js",
33563     "groupTitle": "Voice_Queues"
33564   },
33565   {
33566     "type": "get",
33567     "url": "/api/voice/queues/{id}/hopper_histories",
33568     "title": "Gets queue hopper histories",
33569     "examples": [
33570       {
33571         "title": "Example usage:",
33572         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33573         "type": "json"
33574       }
33575     ],
33576     "name": "GetHopperHistories",
33577     "group": "Voice_Queues",
33578     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33579     "version": "0.0.0",
33580     "filename": "server/api/voiceQueue/index.js",
33581     "groupTitle": "Voice_Queues"
33582   },
33583   {
33584     "type": "get",
33585     "url": "/api/voice/queues/{id}/hoppers",
33586     "title": "Gets queue hoppers",
33587     "examples": [
33588       {
33589         "title": "Example usage:",
33590         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33591         "type": "json"
33592       }
33593     ],
33594     "name": "GetHoppers",
33595     "group": "Voice_Queues",
33596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33597     "version": "0.0.0",
33598     "filename": "server/api/voiceQueue/index.js",
33599     "groupTitle": "Voice_Queues"
33600   },
33601   {
33602     "type": "get",
33603     "url": "/api/voice/queues/{id}/lists",
33604     "title": "Get queue lists",
33605     "examples": [
33606       {
33607         "title": "Example usage:",
33608         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33609         "type": "json"
33610       }
33611     ],
33612     "name": "GetLists",
33613     "group": "Voice_Queues",
33614     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33615     "version": "0.0.0",
33616     "filename": "server/api/voiceQueue/index.js",
33617     "groupTitle": "Voice_Queues"
33618   },
33619   {
33620     "type": "get",
33621     "url": "/api/voice/queues/{id}/members",
33622     "title": "Gets queue members",
33623     "examples": [
33624       {
33625         "title": "Example usage:",
33626         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33627         "type": "json"
33628       }
33629     ],
33630     "name": "GetMembers",
33631     "group": "Voice_Queues",
33632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33633     "version": "0.0.0",
33634     "filename": "server/api/voiceQueue/index.js",
33635     "groupTitle": "Voice_Queues"
33636   },
33637   {
33638     "type": "get",
33639     "url": "/api/voice/queues",
33640     "title": "Gets a list of Queues",
33641     "examples": [
33642       {
33643         "title": "Example usage:",
33644         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33645         "type": "json"
33646       }
33647     ],
33648     "name": "GetQueues",
33649     "group": "Voice_Queues",
33650     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33651     "version": "0.0.0",
33652     "filename": "server/api/voiceQueue/index.js",
33653     "groupTitle": "Voice_Queues"
33654   },
33655   {
33656     "type": "get",
33657     "url": "/api/voice/queues/{id}/teams",
33658     "title": "Gets queue team",
33659     "examples": [
33660       {
33661         "title": "Example usage:",
33662         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33663         "type": "json"
33664       }
33665     ],
33666     "name": "GetTeams",
33667     "group": "Voice_Queues",
33668     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33669     "version": "0.0.0",
33670     "filename": "server/api/voiceQueue/index.js",
33671     "groupTitle": "Voice_Queues"
33672   },
33673   {
33674     "type": "delete",
33675     "url": "/api/voice/queues/{id}/users",
33676     "title": "Removes agents from a queue",
33677     "examples": [
33678       {
33679         "title": "Example usage:",
33680         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33681         "type": "json"
33682       }
33683     ],
33684     "name": "RemoveAgents",
33685     "group": "Voice_Queues",
33686     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33687     "version": "0.0.0",
33688     "filename": "server/api/voiceQueue/index.js",
33689     "groupTitle": "Voice_Queues"
33690   },
33691   {
33692     "type": "delete",
33693     "url": "/api/voice/queues/{id}/blacklists",
33694     "title": "Remove blacklists from a queue",
33695     "examples": [
33696       {
33697         "title": "Example usage:",
33698         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33699         "type": "json"
33700       }
33701     ],
33702     "name": "RemoveBlackLists",
33703     "group": "Voice_Queues",
33704     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33705     "version": "0.0.0",
33706     "filename": "server/api/voiceQueue/index.js",
33707     "groupTitle": "Voice_Queues"
33708   },
33709   {
33710     "type": "delete",
33711     "url": "/api/voice/queues/{id}/lists",
33712     "title": "Remove lists from a queue",
33713     "examples": [
33714       {
33715         "title": "Example usage:",
33716         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33717         "type": "json"
33718       }
33719     ],
33720     "name": "RemoveLists",
33721     "group": "Voice_Queues",
33722     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33723     "version": "0.0.0",
33724     "filename": "server/api/voiceQueue/index.js",
33725     "groupTitle": "Voice_Queues"
33726   },
33727   {
33728     "type": "get",
33729     "url": "/api/voice/queues/{id}",
33730     "title": "Gets a single Queue",
33731     "examples": [
33732       {
33733         "title": "Example usage:",
33734         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33735         "type": "json"
33736       }
33737     ],
33738     "name": "ShowQueues",
33739     "group": "Voice_Queues",
33740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33741     "version": "0.0.0",
33742     "filename": "server/api/voiceQueue/index.js",
33743     "groupTitle": "Voice_Queues"
33744   },
33745   {
33746     "type": "get",
33747     "url": "/api/voice/queues/{id}/blacks",
33748     "title": "Gets queue hopper blacks",
33749     "examples": [
33750       {
33751         "title": "Example usage:",
33752         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33753         "type": "json"
33754       }
33755     ],
33756     "name": "getHopperBlacks",
33757     "group": "Voice_Queues",
33758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33759     "version": "0.0.0",
33760     "filename": "server/api/voiceQueue/index.js",
33761     "groupTitle": "Voice_Queues"
33762   },
33763   {
33764     "type": "put",
33765     "url": "/api/voice/queues/{id}",
33766     "title": "Update an existing Queue",
33767     "examples": [
33768       {
33769         "title": "Example usage:",
33770         "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",
33771         "type": "json"
33772       }
33773     ],
33774     "name": "updateQueues",
33775     "group": "Voice_Queues",
33776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33777     "version": "0.0.0",
33778     "filename": "server/api/voiceQueue/index.js",
33779     "groupTitle": "Voice_Queues"
33780   },
33781   {
33782     "type": "post",
33783     "url": "/api/voice/recordings",
33784     "title": "Creates a new Recording",
33785     "examples": [
33786       {
33787         "title": "Example usage:",
33788         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33789         "type": "json"
33790       }
33791     ],
33792     "name": "CreateRecordings",
33793     "group": "Voice_Recordings",
33794     "parameter": {
33795       "fields": {
33796         "Body": [
33797           {
33798             "group": "Body",
33799             "type": "Virtual",
33800             "optional": true,
33801             "field": "format",
33802             "description": ""
33803           },
33804           {
33805             "group": "Body",
33806             "type": "String",
33807             "optional": true,
33808             "field": "uniqueid",
33809             "description": ""
33810           },
33811           {
33812             "group": "Body",
33813             "type": "String",
33814             "optional": true,
33815             "field": "channel",
33816             "description": ""
33817           },
33818           {
33819             "group": "Body",
33820             "type": "String",
33821             "optional": true,
33822             "field": "membername",
33823             "description": ""
33824           },
33825           {
33826             "group": "Body",
33827             "type": "String",
33828             "optional": true,
33829             "field": "calleridnum",
33830             "description": ""
33831           },
33832           {
33833             "group": "Body",
33834             "type": "String",
33835             "optional": true,
33836             "field": "calleridname",
33837             "description": ""
33838           },
33839           {
33840             "group": "Body",
33841             "type": "String",
33842             "optional": true,
33843             "field": "connectedlinenum",
33844             "description": ""
33845           },
33846           {
33847             "group": "Body",
33848             "type": "String",
33849             "optional": true,
33850             "field": "connectedlinename",
33851             "description": ""
33852           },
33853           {
33854             "group": "Body",
33855             "type": "String",
33856             "optional": true,
33857             "field": "accountcode",
33858             "description": ""
33859           },
33860           {
33861             "group": "Body",
33862             "type": "String",
33863             "optional": true,
33864             "field": "context",
33865             "description": ""
33866           },
33867           {
33868             "group": "Body",
33869             "type": "String",
33870             "optional": true,
33871             "field": "exten",
33872             "description": ""
33873           },
33874           {
33875             "group": "Body",
33876             "type": "String",
33877             "optional": true,
33878             "field": "value",
33879             "description": ""
33880           },
33881           {
33882             "group": "Body",
33883             "type": "String",
33884             "optional": true,
33885             "field": "type",
33886             "description": ""
33887           },
33888           {
33889             "group": "Body",
33890             "type": "Integer",
33891             "optional": true,
33892             "field": "rating",
33893             "description": ""
33894           },
33895           {
33896             "group": "Body",
33897             "type": "String",
33898             "optional": true,
33899             "field": "queue",
33900             "description": ""
33901           },
33902           {
33903             "group": "Body",
33904             "type": "String",
33905             "optional": true,
33906             "field": "userDisposition",
33907             "description": ""
33908           },
33909           {
33910             "group": "Body",
33911             "type": "String",
33912             "optional": true,
33913             "field": "userSecondDisposition",
33914             "description": ""
33915           },
33916           {
33917             "group": "Body",
33918             "type": "String",
33919             "optional": true,
33920             "field": "userThirdDisposition",
33921             "description": ""
33922           },
33923           {
33924             "group": "Body",
33925             "type": "Text",
33926             "optional": true,
33927             "field": "location",
33928             "description": ""
33929           },
33930           {
33931             "group": "Body",
33932             "type": "String",
33933             "optional": true,
33934             "field": "transcribeName",
33935             "description": ""
33936           },
33937           {
33938             "group": "Body",
33939             "type": "String",
33940             "optional": true,
33941             "field": "transcribeStatus",
33942             "description": ""
33943           },
33944           {
33945             "group": "Body",
33946             "type": "Text",
33947             "optional": true,
33948             "field": "fileUri",
33949             "description": ""
33950           },
33951           {
33952             "group": "Body",
33953             "type": "Text",
33954             "optional": true,
33955             "field": "fileText",
33956             "description": ""
33957           },
33958           {
33959             "group": "Body",
33960             "type": "Text",
33961             "optional": true,
33962             "field": "failureReason",
33963             "description": ""
33964           },
33965           {
33966             "group": "Body",
33967             "type": "String",
33968             "optional": true,
33969             "field": "sentiment",
33970             "description": ""
33971           },
33972           {
33973             "group": "Body",
33974             "type": "Float",
33975             "optional": true,
33976             "field": "sPositive",
33977             "description": ""
33978           },
33979           {
33980             "group": "Body",
33981             "type": "Float",
33982             "optional": true,
33983             "field": "sNegative",
33984             "description": ""
33985           },
33986           {
33987             "group": "Body",
33988             "type": "Float",
33989             "optional": true,
33990             "field": "sNeutral",
33991             "description": ""
33992           },
33993           {
33994             "group": "Body",
33995             "type": "Float",
33996             "optional": true,
33997             "field": "sMixed",
33998             "description": ""
33999           },
34000           {
34001             "group": "Body",
34002             "type": "Boolean",
34003             "optional": true,
34004             "field": "tempSentiment",
34005             "description": ""
34006           },
34007           {
34008             "group": "Body",
34009             "type": "String",
34010             "optional": true,
34011             "field": "createdAt",
34012             "description": ""
34013           },
34014           {
34015             "group": "Body",
34016             "type": "String",
34017             "optional": true,
34018             "field": "updatedAt",
34019             "description": ""
34020           }
34021         ]
34022       }
34023     },
34024     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34025     "version": "0.0.0",
34026     "filename": "server/api/voiceRecording/index.js",
34027     "groupTitle": "Voice_Recordings"
34028   },
34029   {
34030     "type": "get",
34031     "url": "/api/voice/recordings/describe",
34032     "title": "Gets table info about Recordings",
34033     "examples": [
34034       {
34035         "title": "Example usage:",
34036         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
34037         "type": "json"
34038       }
34039     ],
34040     "name": "DescribeRecordings",
34041     "group": "Voice_Recordings",
34042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34043     "version": "0.0.0",
34044     "filename": "server/api/voiceRecording/index.js",
34045     "groupTitle": "Voice_Recordings"
34046   },
34047   {
34048     "type": "get",
34049     "url": "/api/voice/recordings",
34050     "title": "Gets a list of Recordings",
34051     "examples": [
34052       {
34053         "title": "Example usage:",
34054         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
34055         "type": "json"
34056       }
34057     ],
34058     "name": "GetRecordings",
34059     "group": "Voice_Recordings",
34060     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34061     "version": "0.0.0",
34062     "filename": "server/api/voiceRecording/index.js",
34063     "groupTitle": "Voice_Recordings"
34064   },
34065   {
34066     "type": "get",
34067     "url": "/api/voice/recordings/{id}",
34068     "title": "Gets a single Recording",
34069     "examples": [
34070       {
34071         "title": "Example usage:",
34072         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
34073         "type": "json"
34074       }
34075     ],
34076     "name": "ShowRecordings",
34077     "group": "Voice_Recordings",
34078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34079     "version": "0.0.0",
34080     "filename": "server/api/voiceRecording/index.js",
34081     "groupTitle": "Voice_Recordings"
34082   },
34083   {
34084     "type": "delete",
34085     "url": "/api/voice/recordings/{id}",
34086     "title": "Delete voice recording",
34087     "examples": [
34088       {
34089         "title": "Example usage:",
34090         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
34091         "type": "json"
34092       }
34093     ],
34094     "name": "destroy",
34095     "group": "Voice_Recordings",
34096     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34097     "version": "0.0.0",
34098     "filename": "server/api/voiceRecording/index.js",
34099     "groupTitle": "Voice_Recordings"
34100   },
34101   {
34102     "type": "get",
34103     "url": "/api/voice/recordings/{id}/download",
34104     "title": "Download Recording",
34105     "examples": [
34106       {
34107         "title": "Example usage:",
34108         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34109         "type": "json"
34110       }
34111     ],
34112     "name": "download",
34113     "group": "Voice_Recordings",
34114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34115     "version": "0.0.0",
34116     "filename": "server/api/voiceRecording/index.js",
34117     "groupTitle": "Voice_Recordings"
34118   },
34119   {
34120     "type": "get",
34121     "url": "/api/voice/recordings/{id}/downloads",
34122     "title": "Download Recording",
34123     "examples": [
34124       {
34125         "title": "Example usage:",
34126         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34127         "type": "json"
34128       }
34129     ],
34130     "name": "downloads",
34131     "group": "Voice_Recordings",
34132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34133     "version": "0.0.0",
34134     "filename": "server/api/voiceRecording/index.js",
34135     "groupTitle": "Voice_Recordings"
34136   },
34137   {
34138     "type": "post",
34139     "url": "/api/voice/recordings/{id}/transcribe",
34140     "title": "Run Transcribe Recording",
34141     "examples": [
34142       {
34143         "title": "Example usage:",
34144         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34145         "type": "json"
34146       }
34147     ],
34148     "name": "transcribe",
34149     "group": "Voice_Recordings",
34150     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34151     "version": "0.0.0",
34152     "filename": "server/api/voiceRecording/index.js",
34153     "groupTitle": "Voice_Recordings"
34154   },
34155   {
34156     "type": "get",
34157     "url": "/api/voice/recordings/{id}/transcribe",
34158     "title": "Run Transcribe Recording",
34159     "examples": [
34160       {
34161         "title": "Example usage:",
34162         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34163         "type": "json"
34164       }
34165     ],
34166     "name": "transcribe",
34167     "group": "Voice_Recordings",
34168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34169     "version": "0.0.0",
34170     "filename": "server/api/voiceRecording/index.js",
34171     "groupTitle": "Voice_Recordings"
34172   },
34173   {
34174     "type": "put",
34175     "url": "/api/voice/recordings/{id}",
34176     "title": "Update an existing Recording",
34177     "examples": [
34178       {
34179         "title": "Example usage:",
34180         "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",
34181         "type": "json"
34182       }
34183     ],
34184     "name": "updateRecordings",
34185     "group": "Voice_Recordings",
34186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34187     "version": "0.0.0",
34188     "filename": "server/api/voiceRecording/index.js",
34189     "groupTitle": "Voice_Recordings"
34190   },
34191   {
34192     "type": "post",
34193     "url": "/api/voice/transfers/reports",
34194     "title": "Creates a new Transfer Report",
34195     "examples": [
34196       {
34197         "title": "Example usage:",
34198         "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",
34199         "type": "json"
34200       }
34201     ],
34202     "name": "CreateTransfer_Reports",
34203     "group": "Voice_Transfer_Reports",
34204     "parameter": {
34205       "fields": {
34206         "Body": [
34207           {
34208             "group": "Body",
34209             "type": "String",
34210             "allowedValues": [
34211               "\"blind\"",
34212               "\"attended\""
34213             ],
34214             "optional": true,
34215             "field": "type",
34216             "description": ""
34217           },
34218           {
34219             "group": "Body",
34220             "type": "String",
34221             "optional": true,
34222             "field": "result",
34223             "description": ""
34224           },
34225           {
34226             "group": "Body",
34227             "type": "String",
34228             "optional": true,
34229             "field": "transfererchannel",
34230             "description": ""
34231           },
34232           {
34233             "group": "Body",
34234             "type": "String",
34235             "optional": true,
34236             "field": "transferercalleridnum",
34237             "description": ""
34238           },
34239           {
34240             "group": "Body",
34241             "type": "String",
34242             "optional": true,
34243             "field": "transferercalleridname",
34244             "description": ""
34245           },
34246           {
34247             "group": "Body",
34248             "type": "String",
34249             "optional": true,
34250             "field": "transfererconnectedlinenum",
34251             "description": ""
34252           },
34253           {
34254             "group": "Body",
34255             "type": "String",
34256             "optional": true,
34257             "field": "transfererconnectedlinename",
34258             "description": ""
34259           },
34260           {
34261             "group": "Body",
34262             "type": "String",
34263             "optional": true,
34264             "field": "transfereraccountcode",
34265             "description": ""
34266           },
34267           {
34268             "group": "Body",
34269             "type": "String",
34270             "optional": true,
34271             "field": "transferercontext",
34272             "description": ""
34273           },
34274           {
34275             "group": "Body",
34276             "type": "String",
34277             "optional": true,
34278             "field": "transfererexten",
34279             "description": ""
34280           },
34281           {
34282             "group": "Body",
34283             "type": "String",
34284             "optional": true,
34285             "field": "transfererlinkedid",
34286             "description": ""
34287           },
34288           {
34289             "group": "Body",
34290             "type": "String",
34291             "optional": true,
34292             "field": "transfereechannel",
34293             "description": ""
34294           },
34295           {
34296             "group": "Body",
34297             "type": "String",
34298             "optional": true,
34299             "field": "transfereecalleridnum",
34300             "description": ""
34301           },
34302           {
34303             "group": "Body",
34304             "type": "String",
34305             "optional": true,
34306             "field": "transfereecalleridname",
34307             "description": ""
34308           },
34309           {
34310             "group": "Body",
34311             "type": "String",
34312             "optional": true,
34313             "field": "transfereeconnectedlinenum",
34314             "description": ""
34315           },
34316           {
34317             "group": "Body",
34318             "type": "String",
34319             "optional": true,
34320             "field": "transfereeconnectedlinename",
34321             "description": ""
34322           },
34323           {
34324             "group": "Body",
34325             "type": "String",
34326             "optional": true,
34327             "field": "transfereeaccountcode",
34328             "description": ""
34329           },
34330           {
34331             "group": "Body",
34332             "type": "String",
34333             "optional": true,
34334             "field": "transfereecontext",
34335             "description": ""
34336           },
34337           {
34338             "group": "Body",
34339             "type": "String",
34340             "optional": true,
34341             "field": "transfereeexten",
34342             "description": ""
34343           },
34344           {
34345             "group": "Body",
34346             "type": "String",
34347             "optional": true,
34348             "field": "transfereelinkedid",
34349             "description": ""
34350           },
34351           {
34352             "group": "Body",
34353             "type": "String",
34354             "allowedValues": [
34355               "\"Yes\"",
34356               "\"No\""
34357             ],
34358             "optional": true,
34359             "field": "isexternal",
34360             "description": ""
34361           },
34362           {
34363             "group": "Body",
34364             "type": "String",
34365             "optional": true,
34366             "field": "context",
34367             "description": ""
34368           },
34369           {
34370             "group": "Body",
34371             "type": "String",
34372             "optional": true,
34373             "field": "extension",
34374             "description": ""
34375           }
34376         ]
34377       }
34378     },
34379     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34380     "version": "0.0.0",
34381     "filename": "server/api/voiceTransferReport/index.js",
34382     "groupTitle": "Voice_Transfer_Reports"
34383   },
34384   {
34385     "type": "delete",
34386     "url": "/api/voice/transfers/reports/{id}",
34387     "title": "Deletes a Transfer Report",
34388     "examples": [
34389       {
34390         "title": "Example usage:",
34391         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34392         "type": "json"
34393       }
34394     ],
34395     "name": "DeleteTransfer_Reports",
34396     "group": "Voice_Transfer_Reports",
34397     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34398     "version": "0.0.0",
34399     "filename": "server/api/voiceTransferReport/index.js",
34400     "groupTitle": "Voice_Transfer_Reports"
34401   },
34402   {
34403     "type": "get",
34404     "url": "/api/voice/transfers/reports/describe",
34405     "title": "Gets table info about Transfer Reports",
34406     "examples": [
34407       {
34408         "title": "Example usage:",
34409         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34410         "type": "json"
34411       }
34412     ],
34413     "name": "DescribeTransfer_Reports",
34414     "group": "Voice_Transfer_Reports",
34415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34416     "version": "0.0.0",
34417     "filename": "server/api/voiceTransferReport/index.js",
34418     "groupTitle": "Voice_Transfer_Reports"
34419   },
34420   {
34421     "type": "get",
34422     "url": "/api/voice/transfers/reports",
34423     "title": "Gets a list of Transfer Reports",
34424     "examples": [
34425       {
34426         "title": "Example usage:",
34427         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34428         "type": "json"
34429       }
34430     ],
34431     "name": "GetTransfer_Reports",
34432     "group": "Voice_Transfer_Reports",
34433     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34434     "version": "0.0.0",
34435     "filename": "server/api/voiceTransferReport/index.js",
34436     "groupTitle": "Voice_Transfer_Reports"
34437   },
34438   {
34439     "type": "get",
34440     "url": "/api/voice/transfers/reports/{id}",
34441     "title": "Gets a single Transfer Report",
34442     "examples": [
34443       {
34444         "title": "Example usage:",
34445         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34446         "type": "json"
34447       }
34448     ],
34449     "name": "ShowTransfer_Reports",
34450     "group": "Voice_Transfer_Reports",
34451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34452     "version": "0.0.0",
34453     "filename": "server/api/voiceTransferReport/index.js",
34454     "groupTitle": "Voice_Transfer_Reports"
34455   },
34456   {
34457     "type": "put",
34458     "url": "/api/voice/transfers/reports/{id}",
34459     "title": "Update an existing Transfer Report",
34460     "examples": [
34461       {
34462         "title": "Example usage:",
34463         "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",
34464         "type": "json"
34465       }
34466     ],
34467     "name": "updateTransfer_Reports",
34468     "group": "Voice_Transfer_Reports",
34469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34470     "version": "0.0.0",
34471     "filename": "server/api/voiceTransferReport/index.js",
34472     "groupTitle": "Voice_Transfer_Reports"
34473   },
34474   {
34475     "type": "post",
34476     "url": "/api/integrations/vtiger/accounts",
34477     "title": "Creates a new Vtiger Account",
34478     "examples": [
34479       {
34480         "title": "Example usage:",
34481         "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",
34482         "type": "json"
34483       }
34484     ],
34485     "name": "CreateVtiger_Accounts",
34486     "group": "Vtiger_Accounts",
34487     "parameter": {
34488       "fields": {
34489         "Body": [
34490           {
34491             "group": "Body",
34492             "type": "String",
34493             "optional": false,
34494             "field": "name",
34495             "description": ""
34496           },
34497           {
34498             "group": "Body",
34499             "type": "String",
34500             "optional": true,
34501             "field": "description",
34502             "description": ""
34503           },
34504           {
34505             "group": "Body",
34506             "type": "String",
34507             "optional": false,
34508             "field": "username",
34509             "description": ""
34510           },
34511           {
34512             "group": "Body",
34513             "type": "String",
34514             "optional": false,
34515             "field": "moduleName",
34516             "description": ""
34517           },
34518           {
34519             "group": "Body",
34520             "type": "String",
34521             "optional": false,
34522             "field": "remoteUri",
34523             "description": ""
34524           },
34525           {
34526             "group": "Body",
34527             "type": "String",
34528             "optional": false,
34529             "field": "serverUrl",
34530             "description": ""
34531           },
34532           {
34533             "group": "Body",
34534             "type": "String",
34535             "optional": false,
34536             "field": "accessKey",
34537             "description": ""
34538           }
34539         ]
34540       }
34541     },
34542     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34543     "version": "0.0.0",
34544     "filename": "server/api/intVtigerAccount/index.js",
34545     "groupTitle": "Vtiger_Accounts"
34546   },
34547   {
34548     "type": "delete",
34549     "url": "/api/integrations/vtiger/accounts/{id}",
34550     "title": "Deletes a Vtiger Account",
34551     "examples": [
34552       {
34553         "title": "Example usage:",
34554         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34555         "type": "json"
34556       }
34557     ],
34558     "name": "DeleteVtiger_Accounts",
34559     "group": "Vtiger_Accounts",
34560     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34561     "version": "0.0.0",
34562     "filename": "server/api/intVtigerAccount/index.js",
34563     "groupTitle": "Vtiger_Accounts"
34564   },
34565   {
34566     "type": "get",
34567     "url": "/api/integrations/vtiger/accounts",
34568     "title": "Gets a list of Vtiger Accounts",
34569     "examples": [
34570       {
34571         "title": "Example usage:",
34572         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34573         "type": "json"
34574       }
34575     ],
34576     "name": "GetVtiger_Accounts",
34577     "group": "Vtiger_Accounts",
34578     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34579     "version": "0.0.0",
34580     "filename": "server/api/intVtigerAccount/index.js",
34581     "groupTitle": "Vtiger_Accounts"
34582   },
34583   {
34584     "type": "get",
34585     "url": "/api/integrations/vtiger/accounts/{id}",
34586     "title": "Gets a single Vtiger Account",
34587     "examples": [
34588       {
34589         "title": "Example usage:",
34590         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34591         "type": "json"
34592       }
34593     ],
34594     "name": "ShowVtiger_Accounts",
34595     "group": "Vtiger_Accounts",
34596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34597     "version": "0.0.0",
34598     "filename": "server/api/intVtigerAccount/index.js",
34599     "groupTitle": "Vtiger_Accounts"
34600   },
34601   {
34602     "type": "post",
34603     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34604     "title": "Creates new configuration",
34605     "examples": [
34606       {
34607         "title": "Example usage:",
34608         "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",
34609         "type": "json"
34610       }
34611     ],
34612     "name": "addConfiguration",
34613     "group": "Vtiger_Accounts",
34614     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34615     "version": "0.0.0",
34616     "filename": "server/api/intVtigerAccount/index.js",
34617     "groupTitle": "Vtiger_Accounts"
34618   },
34619   {
34620     "type": "get",
34621     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34622     "title": "Gets account configurations",
34623     "examples": [
34624       {
34625         "title": "Example usage:",
34626         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34627         "type": "json"
34628       }
34629     ],
34630     "name": "getConfigurations",
34631     "group": "Vtiger_Accounts",
34632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34633     "version": "0.0.0",
34634     "filename": "server/api/intVtigerAccount/index.js",
34635     "groupTitle": "Vtiger_Accounts"
34636   },
34637   {
34638     "type": "get",
34639     "url": "/api/integrations/vtiger/accounts/{id}/fields",
34640     "title": "Gets account fields",
34641     "examples": [
34642       {
34643         "title": "Example usage:",
34644         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34645         "type": "json"
34646       }
34647     ],
34648     "name": "getFields",
34649     "group": "Vtiger_Accounts",
34650     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34651     "version": "0.0.0",
34652     "filename": "server/api/intVtigerAccount/index.js",
34653     "groupTitle": "Vtiger_Accounts"
34654   },
34655   {
34656     "type": "put",
34657     "url": "/api/integrations/vtiger/accounts/{id}",
34658     "title": "Update an existing Vtiger Account",
34659     "examples": [
34660       {
34661         "title": "Example usage:",
34662         "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",
34663         "type": "json"
34664       }
34665     ],
34666     "name": "updateVtiger_Accounts",
34667     "group": "Vtiger_Accounts",
34668     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34669     "version": "0.0.0",
34670     "filename": "server/api/intVtigerAccount/index.js",
34671     "groupTitle": "Vtiger_Accounts"
34672   },
34673   {
34674     "type": "post",
34675     "url": "/api/integrations/vtiger/configurations",
34676     "title": "Creates a new Vtiger Configuration",
34677     "examples": [
34678       {
34679         "title": "Example usage:",
34680         "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",
34681         "type": "json"
34682       }
34683     ],
34684     "name": "CreateVtiger_Configurations",
34685     "group": "Vtiger_Configurations",
34686     "parameter": {
34687       "fields": {
34688         "Body": [
34689           {
34690             "group": "Body",
34691             "type": "String",
34692             "optional": true,
34693             "field": "name",
34694             "description": ""
34695           },
34696           {
34697             "group": "Body",
34698             "type": "String",
34699             "optional": true,
34700             "field": "description",
34701             "description": ""
34702           }
34703         ]
34704       }
34705     },
34706     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34707     "version": "0.0.0",
34708     "filename": "server/api/intVtigerConfiguration/index.js",
34709     "groupTitle": "Vtiger_Configurations"
34710   },
34711   {
34712     "type": "delete",
34713     "url": "/api/integrations/vtiger/configurations/{id}",
34714     "title": "Deletes a Vtiger Configuration",
34715     "examples": [
34716       {
34717         "title": "Example usage:",
34718         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34719         "type": "json"
34720       }
34721     ],
34722     "name": "DeleteVtiger_Configurations",
34723     "group": "Vtiger_Configurations",
34724     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34725     "version": "0.0.0",
34726     "filename": "server/api/intVtigerConfiguration/index.js",
34727     "groupTitle": "Vtiger_Configurations"
34728   },
34729   {
34730     "type": "get",
34731     "url": "/api/integrations/vtiger/configurations",
34732     "title": "Gets a list of Vtiger Configurations",
34733     "examples": [
34734       {
34735         "title": "Example usage:",
34736         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34737         "type": "json"
34738       }
34739     ],
34740     "name": "GetVtiger_Configurations",
34741     "group": "Vtiger_Configurations",
34742     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34743     "version": "0.0.0",
34744     "filename": "server/api/intVtigerConfiguration/index.js",
34745     "groupTitle": "Vtiger_Configurations"
34746   },
34747   {
34748     "type": "get",
34749     "url": "/api/integrations/vtiger/configurations/{id}",
34750     "title": "Gets a single Vtiger Configuration",
34751     "examples": [
34752       {
34753         "title": "Example usage:",
34754         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34755         "type": "json"
34756       }
34757     ],
34758     "name": "ShowVtiger_Configurations",
34759     "group": "Vtiger_Configurations",
34760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34761     "version": "0.0.0",
34762     "filename": "server/api/intVtigerConfiguration/index.js",
34763     "groupTitle": "Vtiger_Configurations"
34764   },
34765   {
34766     "type": "get",
34767     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34768     "title": "Gets configurations descriptions",
34769     "examples": [
34770       {
34771         "title": "Example usage:",
34772         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34773         "type": "json"
34774       }
34775     ],
34776     "name": "getDescriptions",
34777     "group": "Vtiger_Configurations",
34778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34779     "version": "0.0.0",
34780     "filename": "server/api/intVtigerConfiguration/index.js",
34781     "groupTitle": "Vtiger_Configurations"
34782   },
34783   {
34784     "type": "get",
34785     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34786     "title": "Gets configurations fields",
34787     "examples": [
34788       {
34789         "title": "Example usage:",
34790         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34791         "type": "json"
34792       }
34793     ],
34794     "name": "getFields",
34795     "group": "Vtiger_Configurations",
34796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34797     "version": "0.0.0",
34798     "filename": "server/api/intVtigerConfiguration/index.js",
34799     "groupTitle": "Vtiger_Configurations"
34800   },
34801   {
34802     "type": "get",
34803     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34804     "title": "Gets configurations subjects",
34805     "examples": [
34806       {
34807         "title": "Example usage:",
34808         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34809         "type": "json"
34810       }
34811     ],
34812     "name": "getSubjects",
34813     "group": "Vtiger_Configurations",
34814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34815     "version": "0.0.0",
34816     "filename": "server/api/intVtigerConfiguration/index.js",
34817     "groupTitle": "Vtiger_Configurations"
34818   },
34819   {
34820     "type": "put",
34821     "url": "/api/integrations/vtiger/configurations/{id}",
34822     "title": "Update an existing Vtiger Configuration",
34823     "examples": [
34824       {
34825         "title": "Example usage:",
34826         "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",
34827         "type": "json"
34828       }
34829     ],
34830     "name": "updateVtiger_Configurations",
34831     "group": "Vtiger_Configurations",
34832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34833     "version": "0.0.0",
34834     "filename": "server/api/intVtigerConfiguration/index.js",
34835     "groupTitle": "Vtiger_Configurations"
34836   },
34837   {
34838     "type": "post",
34839     "url": "/api/integrations/vtiger/fields",
34840     "title": "Creates a new Vtiger Field",
34841     "examples": [
34842       {
34843         "title": "Example usage:",
34844         "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",
34845         "type": "json"
34846       }
34847     ],
34848     "name": "CreateVtiger_Fields",
34849     "group": "Vtiger_Fields",
34850     "parameter": {
34851       "fields": {
34852         "Body": [
34853           {
34854             "group": "Body",
34855             "type": "String",
34856             "allowedValues": [
34857               "\"string\"",
34858               "\"variable\"",
34859               "\"customVariable\"",
34860               "\"keyValue\"",
34861               "\"picklist\""
34862             ],
34863             "optional": true,
34864             "field": "type",
34865             "description": ""
34866           },
34867           {
34868             "group": "Body",
34869             "type": "String",
34870             "optional": true,
34871             "field": "content",
34872             "description": ""
34873           },
34874           {
34875             "group": "Body",
34876             "type": "String",
34877             "optional": true,
34878             "field": "key",
34879             "description": ""
34880           },
34881           {
34882             "group": "Body",
34883             "type": "String",
34884             "allowedValues": [
34885               "\"string\"",
34886               "\"variable\"",
34887               "\"customVariable\""
34888             ],
34889             "optional": true,
34890             "field": "keyType",
34891             "description": ""
34892           },
34893           {
34894             "group": "Body",
34895             "type": "String",
34896             "optional": true,
34897             "field": "keyContent",
34898             "description": ""
34899           },
34900           {
34901             "group": "Body",
34902             "type": "String",
34903             "optional": true,
34904             "field": "idField",
34905             "description": ""
34906           },
34907           {
34908             "group": "Body",
34909             "type": "String",
34910             "optional": true,
34911             "field": "nameField",
34912             "description": ""
34913           },
34914           {
34915             "group": "Body",
34916             "type": "Boolean",
34917             "optional": true,
34918             "field": "customField",
34919             "description": ""
34920           },
34921           {
34922             "group": "Body",
34923             "type": "String",
34924             "optional": true,
34925             "field": "variableName",
34926             "description": ""
34927           }
34928         ]
34929       }
34930     },
34931     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34932     "version": "0.0.0",
34933     "filename": "server/api/intVtigerField/index.js",
34934     "groupTitle": "Vtiger_Fields"
34935   },
34936   {
34937     "type": "delete",
34938     "url": "/api/integrations/vtiger/fields/{id}",
34939     "title": "Deletes a Vtiger Field",
34940     "examples": [
34941       {
34942         "title": "Example usage:",
34943         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34944         "type": "json"
34945       }
34946     ],
34947     "name": "DeleteVtiger_Fields",
34948     "group": "Vtiger_Fields",
34949     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34950     "version": "0.0.0",
34951     "filename": "server/api/intVtigerField/index.js",
34952     "groupTitle": "Vtiger_Fields"
34953   },
34954   {
34955     "type": "get",
34956     "url": "/api/integrations/vtiger/fields",
34957     "title": "Gets a list of Vtiger Fields",
34958     "examples": [
34959       {
34960         "title": "Example usage:",
34961         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34962         "type": "json"
34963       }
34964     ],
34965     "name": "GetVtiger_Fields",
34966     "group": "Vtiger_Fields",
34967     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34968     "version": "0.0.0",
34969     "filename": "server/api/intVtigerField/index.js",
34970     "groupTitle": "Vtiger_Fields"
34971   },
34972   {
34973     "type": "get",
34974     "url": "/api/integrations/vtiger/fields/{id}",
34975     "title": "Gets a single Vtiger Field",
34976     "examples": [
34977       {
34978         "title": "Example usage:",
34979         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34980         "type": "json"
34981       }
34982     ],
34983     "name": "ShowVtiger_Fields",
34984     "group": "Vtiger_Fields",
34985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34986     "version": "0.0.0",
34987     "filename": "server/api/intVtigerField/index.js",
34988     "groupTitle": "Vtiger_Fields"
34989   },
34990   {
34991     "type": "put",
34992     "url": "/api/integrations/vtiger/fields/{id}",
34993     "title": "Update an existing Vtiger Field",
34994     "examples": [
34995       {
34996         "title": "Example usage:",
34997         "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",
34998         "type": "json"
34999       }
35000     ],
35001     "name": "updateVtiger_Fields",
35002     "group": "Vtiger_Fields",
35003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35004     "version": "0.0.0",
35005     "filename": "server/api/intVtigerField/index.js",
35006     "groupTitle": "Vtiger_Fields"
35007   },
35008   {
35009     "type": "post",
35010     "url": "/api/webbar/answer",
35011     "title": "answer webrtc call",
35012     "examples": [
35013       {
35014         "title": "Example usage:",
35015         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35016         "type": "json"
35017       }
35018     ],
35019     "name": "Web_Bar_answer",
35020     "group": "WebBar",
35021     "parameter": {
35022       "fields": {
35023         "Body": [
35024           {
35025             "group": "Body",
35026             "type": "String",
35027             "optional": false,
35028             "field": "sessionId",
35029             "description": ""
35030           },
35031           {
35032             "group": "Body",
35033             "type": "number",
35034             "optional": false,
35035             "field": "userId",
35036             "description": ""
35037           }
35038         ]
35039       }
35040     },
35041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35042     "version": "0.0.0",
35043     "filename": "server/api/webbar/index.js",
35044     "groupTitle": "WebBar"
35045   },
35046   {
35047     "type": "post",
35048     "url": "/api/webbar/calls",
35049     "title": "webrtc call list",
35050     "examples": [
35051       {
35052         "title": "Example usage:",
35053         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35054         "type": "json"
35055       }
35056     ],
35057     "name": "Web_Bar_calls",
35058     "group": "WebBar",
35059     "parameter": {
35060       "fields": {
35061         "Body": [
35062           {
35063             "group": "Body",
35064             "type": "number",
35065             "optional": false,
35066             "field": "userId",
35067             "description": ""
35068           }
35069         ]
35070       }
35071     },
35072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35073     "version": "0.0.0",
35074     "filename": "server/api/webbar/index.js",
35075     "groupTitle": "WebBar"
35076   },
35077   {
35078     "type": "post",
35079     "url": "/api/webbar/hangup",
35080     "title": "hangup webrtc call",
35081     "examples": [
35082       {
35083         "title": "Example usage:",
35084         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35085         "type": "json"
35086       }
35087     ],
35088     "name": "Web_Bar_hangup",
35089     "group": "WebBar",
35090     "parameter": {
35091       "fields": {
35092         "Body": [
35093           {
35094             "group": "Body",
35095             "type": "String",
35096             "optional": false,
35097             "field": "sessionId",
35098             "description": ""
35099           },
35100           {
35101             "group": "Body",
35102             "type": "number",
35103             "optional": false,
35104             "field": "userId",
35105             "description": ""
35106           }
35107         ]
35108       }
35109     },
35110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35111     "version": "0.0.0",
35112     "filename": "server/api/webbar/index.js",
35113     "groupTitle": "WebBar"
35114   },
35115   {
35116     "type": "post",
35117     "url": "/api/webbar/hold",
35118     "title": "hold webrtc call",
35119     "examples": [
35120       {
35121         "title": "Example usage:",
35122         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35123         "type": "json"
35124       }
35125     ],
35126     "name": "Web_Bar_hold",
35127     "group": "WebBar",
35128     "parameter": {
35129       "fields": {
35130         "Body": [
35131           {
35132             "group": "Body",
35133             "type": "String",
35134             "optional": true,
35135             "field": "sessionId",
35136             "description": ""
35137           },
35138           {
35139             "group": "Body",
35140             "type": "number",
35141             "optional": false,
35142             "field": "userId",
35143             "description": ""
35144           }
35145         ]
35146       }
35147     },
35148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35149     "version": "0.0.0",
35150     "filename": "server/api/webbar/index.js",
35151     "groupTitle": "WebBar"
35152   },
35153   {
35154     "type": "post",
35155     "url": "/api/webbar/unhold",
35156     "title": "unhold webrtc call",
35157     "examples": [
35158       {
35159         "title": "Example usage:",
35160         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35161         "type": "json"
35162       }
35163     ],
35164     "name": "Web_Bar_hold",
35165     "group": "WebBar",
35166     "parameter": {
35167       "fields": {
35168         "Body": [
35169           {
35170             "group": "Body",
35171             "type": "String",
35172             "optional": false,
35173             "field": "sessionId",
35174             "description": ""
35175           },
35176           {
35177             "group": "Body",
35178             "type": "number",
35179             "optional": false,
35180             "field": "userId",
35181             "description": ""
35182           }
35183         ]
35184       }
35185     },
35186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35187     "version": "0.0.0",
35188     "filename": "server/api/webbar/index.js",
35189     "groupTitle": "WebBar"
35190   },
35191   {
35192     "type": "post",
35193     "url": "/api/webbar/originate",
35194     "title": "Originate new webrtc call",
35195     "examples": [
35196       {
35197         "title": "Example usage:",
35198         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35199         "type": "json"
35200       }
35201     ],
35202     "name": "Web_Bar_originate",
35203     "group": "WebBar",
35204     "parameter": {
35205       "fields": {
35206         "Body": [
35207           {
35208             "group": "Body",
35209             "type": "String",
35210             "optional": false,
35211             "field": "callNumber",
35212             "description": ""
35213           },
35214           {
35215             "group": "Body",
35216             "type": "number",
35217             "optional": false,
35218             "field": "userId",
35219             "description": ""
35220           },
35221           {
35222             "group": "Body",
35223             "type": "String",
35224             "optional": false,
35225             "field": "callerId",
35226             "description": ""
35227           },
35228           {
35229             "group": "Body",
35230             "type": "String",
35231             "optional": false,
35232             "field": "callbackUrl",
35233             "description": ""
35234           }
35235         ]
35236       }
35237     },
35238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35239     "version": "0.0.0",
35240     "filename": "server/api/webbar/index.js",
35241     "groupTitle": "WebBar"
35242   },
35243   {
35244     "type": "post",
35245     "url": "/api/webbar/transfer",
35246     "title": "blind transfer webrtc call",
35247     "examples": [
35248       {
35249         "title": "Example usage:",
35250         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35251         "type": "json"
35252       }
35253     ],
35254     "name": "Web_Bar_transfer",
35255     "group": "WebBar",
35256     "parameter": {
35257       "fields": {
35258         "Body": [
35259           {
35260             "group": "Body",
35261             "type": "number",
35262             "optional": false,
35263             "field": "userId",
35264             "description": ""
35265           },
35266           {
35267             "group": "Body",
35268             "type": "string",
35269             "optional": false,
35270             "field": "sessionId",
35271             "description": ""
35272           },
35273           {
35274             "group": "Body",
35275             "type": "string",
35276             "optional": false,
35277             "field": "transferNumber",
35278             "description": ""
35279           }
35280         ]
35281       }
35282     },
35283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35284     "version": "0.0.0",
35285     "filename": "server/api/webbar/index.js",
35286     "groupTitle": "WebBar"
35287   },
35288   {
35289     "type": "post",
35290     "url": "/api/whatsapp/accounts/{id}/users",
35291     "title": "Add agents to a whatsapp account",
35292     "examples": [
35293       {
35294         "title": "Example usage:",
35295         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35296         "type": "json"
35297       }
35298     ],
35299     "name": "AddAgents",
35300     "group": "Whatsapp_Accounts",
35301     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35302     "version": "0.0.0",
35303     "filename": "server/api/whatsappAccount/index.js",
35304     "groupTitle": "Whatsapp_Accounts"
35305   },
35306   {
35307     "type": "post",
35308     "url": "/api/whatsapp/accounts",
35309     "title": "Creates a new Account",
35310     "examples": [
35311       {
35312         "title": "Example usage:",
35313         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35314         "type": "json"
35315       }
35316     ],
35317     "name": "CreateAccounts",
35318     "group": "Whatsapp_Accounts",
35319     "parameter": {
35320       "fields": {
35321         "Body": [
35322           {
35323             "group": "Body",
35324             "type": "String",
35325             "optional": false,
35326             "field": "name",
35327             "description": ""
35328           },
35329           {
35330             "group": "Body",
35331             "type": "String",
35332             "optional": false,
35333             "field": "key",
35334             "description": ""
35335           },
35336           {
35337             "group": "Body",
35338             "type": "String",
35339             "optional": false,
35340             "field": "remote",
35341             "description": ""
35342           },
35343           {
35344             "group": "Body",
35345             "type": "String",
35346             "optional": true,
35347             "field": "token",
35348             "description": ""
35349           },
35350           {
35351             "group": "Body",
35352             "type": "String",
35353             "optional": true,
35354             "field": "phone",
35355             "description": ""
35356           },
35357           {
35358             "group": "Body",
35359             "type": "String",
35360             "allowedValues": [
35361               "\"twilio\""
35362             ],
35363             "optional": true,
35364             "field": "type",
35365             "description": ""
35366           },
35367           {
35368             "group": "Body",
35369             "type": "String",
35370             "optional": true,
35371             "field": "accountSid",
35372             "description": ""
35373           },
35374           {
35375             "group": "Body",
35376             "type": "String",
35377             "optional": true,
35378             "field": "authToken",
35379             "description": ""
35380           },
35381           {
35382             "group": "Body",
35383             "type": "Text",
35384             "optional": true,
35385             "field": "notificationTemplate",
35386             "description": ""
35387           },
35388           {
35389             "group": "Body",
35390             "type": "Boolean",
35391             "optional": true,
35392             "field": "notificationSound",
35393             "description": ""
35394           },
35395           {
35396             "group": "Body",
35397             "type": "Boolean",
35398             "optional": true,
35399             "field": "notificationShake",
35400             "description": ""
35401           },
35402           {
35403             "group": "Body",
35404             "type": "Integer",
35405             "optional": true,
35406             "field": "waitForTheAssignedAgent",
35407             "description": ""
35408           },
35409           {
35410             "group": "Body",
35411             "type": "Integer",
35412             "optional": true,
35413             "field": "waitForTheAssignedQueue",
35414             "description": ""
35415           },
35416           {
35417             "group": "Body",
35418             "type": "Boolean",
35419             "optional": true,
35420             "field": "queueTransfer",
35421             "description": ""
35422           },
35423           {
35424             "group": "Body",
35425             "type": "Integer",
35426             "optional": true,
35427             "field": "queueTransferTimeout",
35428             "description": ""
35429           },
35430           {
35431             "group": "Body",
35432             "type": "Boolean",
35433             "optional": true,
35434             "field": "agentTransfer",
35435             "description": ""
35436           },
35437           {
35438             "group": "Body",
35439             "type": "Integer",
35440             "optional": true,
35441             "field": "agentTransferTimeout",
35442             "description": ""
35443           },
35444           {
35445             "group": "Body",
35446             "type": "Integer",
35447             "optional": true,
35448             "field": "mandatoryDispositionPauseId",
35449             "description": "<p>Status to put when mandatory disposition is enabled</p>"
35450           },
35451           {
35452             "group": "Body",
35453             "type": "Boolean",
35454             "optional": true,
35455             "field": "mandatoryDisposition",
35456             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35457           },
35458           {
35459             "group": "Body",
35460             "type": "String",
35461             "optional": true,
35462             "field": "description",
35463             "description": ""
35464           }
35465         ]
35466       }
35467     },
35468     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35469     "version": "0.0.0",
35470     "filename": "server/api/whatsappAccount/index.js",
35471     "groupTitle": "Whatsapp_Accounts"
35472   },
35473   {
35474     "type": "delete",
35475     "url": "/api/whatsapp/accounts/{id}",
35476     "title": "Deletes a Account",
35477     "examples": [
35478       {
35479         "title": "Example usage:",
35480         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35481         "type": "json"
35482       }
35483     ],
35484     "name": "DeleteAccounts",
35485     "group": "Whatsapp_Accounts",
35486     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35487     "version": "0.0.0",
35488     "filename": "server/api/whatsappAccount/index.js",
35489     "groupTitle": "Whatsapp_Accounts"
35490   },
35491   {
35492     "type": "get",
35493     "url": "/api/whatsapp/accounts/describe",
35494     "title": "Gets table info about Accounts",
35495     "examples": [
35496       {
35497         "title": "Example usage:",
35498         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35499         "type": "json"
35500       }
35501     ],
35502     "name": "DescribeAccounts",
35503     "group": "Whatsapp_Accounts",
35504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35505     "version": "0.0.0",
35506     "filename": "server/api/whatsappAccount/index.js",
35507     "groupTitle": "Whatsapp_Accounts"
35508   },
35509   {
35510     "type": "get",
35511     "url": "/api/whatsapp/accounts",
35512     "title": "Gets a list of Accounts",
35513     "examples": [
35514       {
35515         "title": "Example usage:",
35516         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35517         "type": "json"
35518       }
35519     ],
35520     "name": "GetAccounts",
35521     "group": "Whatsapp_Accounts",
35522     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35523     "version": "0.0.0",
35524     "filename": "server/api/whatsappAccount/index.js",
35525     "groupTitle": "Whatsapp_Accounts"
35526   },
35527   {
35528     "type": "get",
35529     "url": "/api/whatsapp/accounts/{id}/users",
35530     "title": "Gets agents from whatsapp account",
35531     "examples": [
35532       {
35533         "title": "Example usage:",
35534         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35535         "type": "json"
35536       }
35537     ],
35538     "name": "GetAgents",
35539     "group": "Whatsapp_Accounts",
35540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35541     "version": "0.0.0",
35542     "filename": "server/api/whatsappAccount/index.js",
35543     "groupTitle": "Whatsapp_Accounts"
35544   },
35545   {
35546     "type": "delete",
35547     "url": "/api/whatsapp/accounts/{id}/users",
35548     "title": "Removes agents from a whatsapp account",
35549     "examples": [
35550       {
35551         "title": "Example usage:",
35552         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35553         "type": "json"
35554       }
35555     ],
35556     "name": "RemoveAgents",
35557     "group": "Whatsapp_Accounts",
35558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35559     "version": "0.0.0",
35560     "filename": "server/api/whatsappAccount/index.js",
35561     "groupTitle": "Whatsapp_Accounts"
35562   },
35563   {
35564     "type": "delete",
35565     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35566     "title": "Removes canned answers from account",
35567     "examples": [
35568       {
35569         "title": "Example usage:",
35570         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35571         "type": "json"
35572       }
35573     ],
35574     "name": "RemoveAnswers",
35575     "group": "Whatsapp_Accounts",
35576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35577     "version": "0.0.0",
35578     "filename": "server/api/whatsappAccount/index.js",
35579     "groupTitle": "Whatsapp_Accounts"
35580   },
35581   {
35582     "type": "delete",
35583     "url": "/api/whatsapp/accounts/{id}/dispositions",
35584     "title": "Removes dispositions from account",
35585     "examples": [
35586       {
35587         "title": "Example usage:",
35588         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35589         "type": "json"
35590       }
35591     ],
35592     "name": "RemoveDispositions",
35593     "group": "Whatsapp_Accounts",
35594     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35595     "version": "0.0.0",
35596     "filename": "server/api/whatsappAccount/index.js",
35597     "groupTitle": "Whatsapp_Accounts"
35598   },
35599   {
35600     "type": "get",
35601     "url": "/api/whatsapp/accounts/{id}",
35602     "title": "Gets a single Account",
35603     "examples": [
35604       {
35605         "title": "Example usage:",
35606         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35607         "type": "json"
35608       }
35609     ],
35610     "name": "ShowAccounts",
35611     "group": "Whatsapp_Accounts",
35612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35613     "version": "0.0.0",
35614     "filename": "server/api/whatsappAccount/index.js",
35615     "groupTitle": "Whatsapp_Accounts"
35616   },
35617   {
35618     "type": "put",
35619     "url": "/api/whatsapp/messages/{id}/accept",
35620     "title": "Accepts message",
35621     "examples": [
35622       {
35623         "title": "Example usage:",
35624         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35625         "type": "json"
35626       }
35627     ],
35628     "name": "acceptMessage",
35629     "group": "Whatsapp_Accounts",
35630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35631     "version": "0.0.0",
35632     "filename": "server/api/whatsappMessage/index.js",
35633     "groupTitle": "Whatsapp_Accounts"
35634   },
35635   {
35636     "type": "post",
35637     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35638     "title": "Creates new canned answer",
35639     "examples": [
35640       {
35641         "title": "Example usage:",
35642         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35643         "type": "json"
35644       }
35645     ],
35646     "name": "addAnswer",
35647     "group": "Whatsapp_Accounts",
35648     "parameter": {
35649       "fields": {
35650         "Body": [
35651           {
35652             "group": "Body",
35653             "type": "String",
35654             "optional": false,
35655             "field": "key",
35656             "description": ""
35657           },
35658           {
35659             "group": "Body",
35660             "type": "Text",
35661             "optional": false,
35662             "field": "value",
35663             "description": ""
35664           },
35665           {
35666             "group": "Body",
35667             "type": "String",
35668             "optional": true,
35669             "field": "description",
35670             "description": ""
35671           },
35672           {
35673             "group": "Body",
35674             "type": "Virtual",
35675             "optional": true,
35676             "field": "name",
35677             "description": ""
35678           }
35679         ]
35680       }
35681     },
35682     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35683     "version": "0.0.0",
35684     "filename": "server/api/whatsappAccount/index.js",
35685     "groupTitle": "Whatsapp_Accounts"
35686   },
35687   {
35688     "type": "post",
35689     "url": "/api/whatsapp/accounts/{id}/applications",
35690     "title": "Creates new applications",
35691     "examples": [
35692       {
35693         "title": "Example usage:",
35694         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35695         "type": "json"
35696       }
35697     ],
35698     "name": "addApplications",
35699     "group": "Whatsapp_Accounts",
35700     "parameter": {
35701       "fields": {
35702         "Body": [
35703           {
35704             "group": "Body",
35705             "type": "Integer",
35706             "optional": false,
35707             "field": "priority",
35708             "description": ""
35709           },
35710           {
35711             "group": "Body",
35712             "type": "String",
35713             "optional": false,
35714             "field": "app",
35715             "description": ""
35716           },
35717           {
35718             "group": "Body",
35719             "type": "Text",
35720             "optional": true,
35721             "field": "appdata",
35722             "description": ""
35723           },
35724           {
35725             "group": "Body",
35726             "type": "String",
35727             "optional": true,
35728             "field": "description",
35729             "description": ""
35730           },
35731           {
35732             "group": "Body",
35733             "type": "String",
35734             "optional": true,
35735             "field": "interval",
35736             "description": ""
35737           }
35738         ]
35739       }
35740     },
35741     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35742     "version": "0.0.0",
35743     "filename": "server/api/whatsappAccount/index.js",
35744     "groupTitle": "Whatsapp_Accounts"
35745   },
35746   {
35747     "type": "post",
35748     "url": "/api/whatsapp/accounts/{id}/dispositions",
35749     "title": "Creates new disposition",
35750     "examples": [
35751       {
35752         "title": "Example usage:",
35753         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35754         "type": "json"
35755       }
35756     ],
35757     "name": "addDisposition",
35758     "group": "Whatsapp_Accounts",
35759     "parameter": {
35760       "fields": {
35761         "Body": [
35762           {
35763             "group": "Body",
35764             "type": "String",
35765             "optional": false,
35766             "field": "name",
35767             "description": ""
35768           },
35769           {
35770             "group": "Body",
35771             "type": "String",
35772             "allowedValues": [
35773               "\"first\"",
35774               "\"second\"",
35775               "\"third\""
35776             ],
35777             "optional": false,
35778             "field": "level",
35779             "description": ""
35780           },
35781           {
35782             "group": "Body",
35783             "type": "String",
35784             "optional": true,
35785             "field": "description",
35786             "description": ""
35787           }
35788         ]
35789       }
35790     },
35791     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35792     "version": "0.0.0",
35793     "filename": "server/api/whatsappAccount/index.js",
35794     "groupTitle": "Whatsapp_Accounts"
35795   },
35796   {
35797     "type": "get",
35798     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35799     "title": "Gets account canned answers",
35800     "examples": [
35801       {
35802         "title": "Example usage:",
35803         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35804         "type": "json"
35805       }
35806     ],
35807     "name": "getAnswers",
35808     "group": "Whatsapp_Accounts",
35809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35810     "version": "0.0.0",
35811     "filename": "server/api/whatsappAccount/index.js",
35812     "groupTitle": "Whatsapp_Accounts"
35813   },
35814   {
35815     "type": "get",
35816     "url": "/api/whatsapp/accounts/{id}/applications",
35817     "title": "Gets account applications",
35818     "examples": [
35819       {
35820         "title": "Example usage:",
35821         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35822         "type": "json"
35823       }
35824     ],
35825     "name": "getApplications",
35826     "group": "Whatsapp_Accounts",
35827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35828     "version": "0.0.0",
35829     "filename": "server/api/whatsappAccount/index.js",
35830     "groupTitle": "Whatsapp_Accounts"
35831   },
35832   {
35833     "type": "get",
35834     "url": "/api/whatsapp/accounts/{id}/dispositions",
35835     "title": "Gets account dispositions",
35836     "examples": [
35837       {
35838         "title": "Example usage:",
35839         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35840         "type": "json"
35841       }
35842     ],
35843     "name": "getDispositions",
35844     "group": "Whatsapp_Accounts",
35845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35846     "version": "0.0.0",
35847     "filename": "server/api/whatsappAccount/index.js",
35848     "groupTitle": "Whatsapp_Accounts"
35849   },
35850   {
35851     "type": "post",
35852     "url": "/api/whatsapp/accounts/{id}/notify",
35853     "title": "Notify new message",
35854     "examples": [
35855       {
35856         "title": "Example usage:",
35857         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35858         "type": "json"
35859       }
35860     ],
35861     "name": "notify",
35862     "group": "Whatsapp_Accounts",
35863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new whatsapp message to be sent to the system.</p>",
35864     "version": "0.0.0",
35865     "filename": "server/api/whatsappAccount/index.js",
35866     "groupTitle": "Whatsapp_Accounts"
35867   },
35868   {
35869     "type": "put",
35870     "url": "/api/whatsapp/messages/{id}/reject",
35871     "title": "Rejects message",
35872     "examples": [
35873       {
35874         "title": "Example usage:",
35875         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35876         "type": "json"
35877       }
35878     ],
35879     "name": "rejectMessage",
35880     "group": "Whatsapp_Accounts",
35881     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35882     "version": "0.0.0",
35883     "filename": "server/api/whatsappMessage/index.js",
35884     "groupTitle": "Whatsapp_Accounts"
35885   },
35886   {
35887     "type": "post",
35888     "url": "/api/whatsapp/accounts/{id}/send",
35889     "title": "Send new whatsapp message",
35890     "examples": [
35891       {
35892         "title": "Example usage:",
35893         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35894         "type": "json"
35895       }
35896     ],
35897     "name": "sendWhatsapp",
35898     "group": "Whatsapp_Accounts",
35899     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35900     "version": "0.0.0",
35901     "filename": "server/api/whatsappAccount/index.js",
35902     "groupTitle": "Whatsapp_Accounts"
35903   },
35904   {
35905     "type": "post",
35906     "url": "/api/whatsapp/messages/{id}/status",
35907     "title": "Receive message status",
35908     "examples": [
35909       {
35910         "title": "Example usage:",
35911         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35912         "type": "json"
35913       }
35914     ],
35915     "name": "statusMessage",
35916     "group": "Whatsapp_Accounts",
35917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35918     "version": "0.0.0",
35919     "filename": "server/api/whatsappMessage/index.js",
35920     "groupTitle": "Whatsapp_Accounts"
35921   },
35922   {
35923     "type": "put",
35924     "url": "/api/whatsapp/accounts/{id}",
35925     "title": "Update an existing Account",
35926     "examples": [
35927       {
35928         "title": "Example usage:",
35929         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35930         "type": "json"
35931       }
35932     ],
35933     "name": "updateAccounts",
35934     "group": "Whatsapp_Accounts",
35935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35936     "version": "0.0.0",
35937     "filename": "server/api/whatsappAccount/index.js",
35938     "groupTitle": "Whatsapp_Accounts"
35939   },
35940   {
35941     "type": "post",
35942     "url": "/api/whatsapp/applications",
35943     "title": "Creates a new Application",
35944     "examples": [
35945       {
35946         "title": "Example usage:",
35947         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35948         "type": "json"
35949       }
35950     ],
35951     "name": "CreateApplications",
35952     "group": "Whatsapp_Applications",
35953     "parameter": {
35954       "fields": {
35955         "Body": [
35956           {
35957             "group": "Body",
35958             "type": "Integer",
35959             "optional": false,
35960             "field": "priority",
35961             "description": ""
35962           },
35963           {
35964             "group": "Body",
35965             "type": "String",
35966             "optional": false,
35967             "field": "app",
35968             "description": ""
35969           },
35970           {
35971             "group": "Body",
35972             "type": "Text",
35973             "optional": true,
35974             "field": "appdata",
35975             "description": ""
35976           },
35977           {
35978             "group": "Body",
35979             "type": "String",
35980             "optional": true,
35981             "field": "description",
35982             "description": ""
35983           },
35984           {
35985             "group": "Body",
35986             "type": "String",
35987             "optional": true,
35988             "field": "interval",
35989             "description": ""
35990           }
35991         ]
35992       }
35993     },
35994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35995     "version": "0.0.0",
35996     "filename": "server/api/whatsappApplication/index.js",
35997     "groupTitle": "Whatsapp_Applications"
35998   },
35999   {
36000     "type": "delete",
36001     "url": "/api/whatsapp/applications/{id}",
36002     "title": "Deletes a Application",
36003     "examples": [
36004       {
36005         "title": "Example usage:",
36006         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
36007         "type": "json"
36008       }
36009     ],
36010     "name": "DeleteApplications",
36011     "group": "Whatsapp_Applications",
36012     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36013     "version": "0.0.0",
36014     "filename": "server/api/whatsappApplication/index.js",
36015     "groupTitle": "Whatsapp_Applications"
36016   },
36017   {
36018     "type": "get",
36019     "url": "/api/whatsapp/applications",
36020     "title": "Gets a list of Applications",
36021     "examples": [
36022       {
36023         "title": "Example usage:",
36024         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
36025         "type": "json"
36026       }
36027     ],
36028     "name": "GetApplications",
36029     "group": "Whatsapp_Applications",
36030     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36031     "version": "0.0.0",
36032     "filename": "server/api/whatsappApplication/index.js",
36033     "groupTitle": "Whatsapp_Applications"
36034   },
36035   {
36036     "type": "get",
36037     "url": "/api/whatsapp/applications/{id}",
36038     "title": "Gets a single Application",
36039     "examples": [
36040       {
36041         "title": "Example usage:",
36042         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
36043         "type": "json"
36044       }
36045     ],
36046     "name": "ShowApplications",
36047     "group": "Whatsapp_Applications",
36048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36049     "version": "0.0.0",
36050     "filename": "server/api/whatsappApplication/index.js",
36051     "groupTitle": "Whatsapp_Applications"
36052   },
36053   {
36054     "type": "put",
36055     "url": "/api/whatsapp/applications/{id}",
36056     "title": "Update an existing Application",
36057     "examples": [
36058       {
36059         "title": "Example usage:",
36060         "content": "curl https://{domain}/api/whatsapp/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36061         "type": "json"
36062       }
36063     ],
36064     "name": "updateApplications",
36065     "group": "Whatsapp_Applications",
36066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36067     "version": "0.0.0",
36068     "filename": "server/api/whatsappApplication/index.js",
36069     "groupTitle": "Whatsapp_Applications"
36070   },
36071   {
36072     "type": "post",
36073     "url": "/api/whatsapp/interactions/{id}/tags",
36074     "title": "Add tags to the interaction",
36075     "examples": [
36076       {
36077         "title": "Example usage:",
36078         "content": "curl https://{domain}/api/whatsapp/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36079         "type": "json"
36080       }
36081     ],
36082     "name": "AddTags",
36083     "group": "Whatsapp_Interactions",
36084     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36085     "version": "0.0.0",
36086     "filename": "server/api/whatsappInteraction/index.js",
36087     "groupTitle": "Whatsapp_Interactions"
36088   },
36089   {
36090     "type": "post",
36091     "url": "/api/whatsapp/interactions",
36092     "title": "Creates a new Interaction",
36093     "examples": [
36094       {
36095         "title": "Example usage:",
36096         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36097         "type": "json"
36098       }
36099     ],
36100     "name": "CreateInteractions",
36101     "group": "Whatsapp_Interactions",
36102     "parameter": {
36103       "fields": {
36104         "Body": [
36105           {
36106             "group": "Body",
36107             "type": "Boolean",
36108             "optional": true,
36109             "field": "closed",
36110             "description": ""
36111           },
36112           {
36113             "group": "Body",
36114             "type": "String",
36115             "optional": true,
36116             "field": "closedAt",
36117             "description": ""
36118           },
36119           {
36120             "group": "Body",
36121             "type": "String",
36122             "optional": true,
36123             "field": "disposition",
36124             "description": ""
36125           },
36126           {
36127             "group": "Body",
36128             "type": "String",
36129             "optional": true,
36130             "field": "secondDisposition",
36131             "description": ""
36132           },
36133           {
36134             "group": "Body",
36135             "type": "String",
36136             "optional": true,
36137             "field": "thirdDisposition",
36138             "description": ""
36139           },
36140           {
36141             "group": "Body",
36142             "type": "String",
36143             "optional": true,
36144             "field": "note",
36145             "description": ""
36146           },
36147           {
36148             "group": "Body",
36149             "type": "String",
36150             "optional": true,
36151             "field": "phone",
36152             "description": ""
36153           },
36154           {
36155             "group": "Body",
36156             "type": "String",
36157             "optional": true,
36158             "field": "read1stAt",
36159             "description": ""
36160           },
36161           {
36162             "group": "Body",
36163             "type": "String",
36164             "allowedValues": [
36165               "\"in\"",
36166               "\"out\""
36167             ],
36168             "optional": false,
36169             "field": "firstMsgDirection",
36170             "description": ""
36171           },
36172           {
36173             "group": "Body",
36174             "type": "String",
36175             "optional": true,
36176             "field": "lastMsgAt",
36177             "description": ""
36178           },
36179           {
36180             "group": "Body",
36181             "type": "String",
36182             "allowedValues": [
36183               "\"in\"",
36184               "\"out\""
36185             ],
36186             "optional": false,
36187             "field": "lastMsgDirection",
36188             "description": ""
36189           },
36190           {
36191             "group": "Body",
36192             "type": "Boolean",
36193             "optional": true,
36194             "field": "autoreplyExecuted",
36195             "description": ""
36196           }
36197         ]
36198       }
36199     },
36200     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36201     "version": "0.0.0",
36202     "filename": "server/api/whatsappInteraction/index.js",
36203     "groupTitle": "Whatsapp_Interactions"
36204   },
36205   {
36206     "type": "delete",
36207     "url": "/api/whatsapp/interactions/{id}",
36208     "title": "Deletes a Interaction",
36209     "examples": [
36210       {
36211         "title": "Example usage:",
36212         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36213         "type": "json"
36214       }
36215     ],
36216     "name": "DeleteInteractions",
36217     "group": "Whatsapp_Interactions",
36218     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36219     "version": "0.0.0",
36220     "filename": "server/api/whatsappInteraction/index.js",
36221     "groupTitle": "Whatsapp_Interactions"
36222   },
36223   {
36224     "type": "get",
36225     "url": "/api/whatsapp/interactions/describe",
36226     "title": "Gets table info about Interactions",
36227     "examples": [
36228       {
36229         "title": "Example usage:",
36230         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36231         "type": "json"
36232       }
36233     ],
36234     "name": "DescribeInteractions",
36235     "group": "Whatsapp_Interactions",
36236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36237     "version": "0.0.0",
36238     "filename": "server/api/whatsappInteraction/index.js",
36239     "groupTitle": "Whatsapp_Interactions"
36240   },
36241   {
36242     "type": "get",
36243     "url": "/api/whatsapp/interactions",
36244     "title": "Gets a list of Interactions",
36245     "examples": [
36246       {
36247         "title": "Example usage:",
36248         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36249         "type": "json"
36250       }
36251     ],
36252     "name": "GetInteractions",
36253     "group": "Whatsapp_Interactions",
36254     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36255     "version": "0.0.0",
36256     "filename": "server/api/whatsappInteraction/index.js",
36257     "groupTitle": "Whatsapp_Interactions"
36258   },
36259   {
36260     "type": "delete",
36261     "url": "/api/whatsapp/interactions/{id}/tags",
36262     "title": "Removes tags from interaction",
36263     "examples": [
36264       {
36265         "title": "Example usage:",
36266         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36267         "type": "json"
36268       }
36269     ],
36270     "name": "RemoveTags",
36271     "group": "Whatsapp_Interactions",
36272     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36273     "version": "0.0.0",
36274     "filename": "server/api/whatsappInteraction/index.js",
36275     "groupTitle": "Whatsapp_Interactions"
36276   },
36277   {
36278     "type": "get",
36279     "url": "/api/whatsapp/interactions/{id}",
36280     "title": "Gets a single Interaction",
36281     "examples": [
36282       {
36283         "title": "Example usage:",
36284         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36285         "type": "json"
36286       }
36287     ],
36288     "name": "ShowInteractions",
36289     "group": "Whatsapp_Interactions",
36290     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36291     "version": "0.0.0",
36292     "filename": "server/api/whatsappInteraction/index.js",
36293     "groupTitle": "Whatsapp_Interactions"
36294   },
36295   {
36296     "type": "post",
36297     "url": "/api/whatsapp/interactions/{id}/messages",
36298     "title": "Creates new messages",
36299     "examples": [
36300       {
36301         "title": "Example usage:",
36302         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36303         "type": "json"
36304       }
36305     ],
36306     "name": "addMessage",
36307     "group": "Whatsapp_Interactions",
36308     "parameter": {
36309       "fields": {
36310         "Body": [
36311           {
36312             "group": "Body",
36313             "type": "Text",
36314             "optional": false,
36315             "field": "body",
36316             "description": ""
36317           },
36318           {
36319             "group": "Body",
36320             "type": "Boolean",
36321             "optional": true,
36322             "field": "read",
36323             "description": ""
36324           },
36325           {
36326             "group": "Body",
36327             "type": "String",
36328             "allowedValues": [
36329               "\"in\"",
36330               "\"out\""
36331             ],
36332             "optional": false,
36333             "field": "direction",
36334             "description": ""
36335           },
36336           {
36337             "group": "Body",
36338             "type": "String",
36339             "optional": true,
36340             "field": "messageId",
36341             "description": ""
36342           },
36343           {
36344             "group": "Body",
36345             "type": "String",
36346             "optional": true,
36347             "field": "phone",
36348             "description": ""
36349           },
36350           {
36351             "group": "Body",
36352             "type": "String",
36353             "optional": true,
36354             "field": "readAt",
36355             "description": ""
36356           },
36357           {
36358             "group": "Body",
36359             "type": "Boolean",
36360             "optional": true,
36361             "field": "secret",
36362             "description": ""
36363           },
36364           {
36365             "group": "Body",
36366             "type": "String",
36367             "optional": true,
36368             "field": "providerName",
36369             "description": ""
36370           },
36371           {
36372             "group": "Body",
36373             "type": "Text",
36374             "optional": true,
36375             "field": "providerResponse",
36376             "description": ""
36377           }
36378         ]
36379       }
36380     },
36381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36382     "version": "0.0.0",
36383     "filename": "server/api/whatsappInteraction/index.js",
36384     "groupTitle": "Whatsapp_Interactions"
36385   },
36386   {
36387     "type": "get",
36388     "url": "/api/whatsapp/interactions/{id}/download",
36389     "title": "Gets interaction",
36390     "examples": [
36391       {
36392         "title": "Example usage:",
36393         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36394         "type": "json"
36395       }
36396     ],
36397     "name": "download",
36398     "group": "Whatsapp_Interactions",
36399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36400     "version": "0.0.0",
36401     "filename": "server/api/whatsappInteraction/index.js",
36402     "groupTitle": "Whatsapp_Interactions"
36403   },
36404   {
36405     "type": "get",
36406     "url": "/api/whatsapp/interactions/{id}/messages",
36407     "title": "Gets interaction messages",
36408     "examples": [
36409       {
36410         "title": "Example usage:",
36411         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36412         "type": "json"
36413       }
36414     ],
36415     "name": "getMessages",
36416     "group": "Whatsapp_Interactions",
36417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36418     "version": "0.0.0",
36419     "filename": "server/api/whatsappInteraction/index.js",
36420     "groupTitle": "Whatsapp_Interactions"
36421   },
36422   {
36423     "type": "put",
36424     "url": "/api/whatsapp/interactions/{id}",
36425     "title": "Update an existing Interaction",
36426     "examples": [
36427       {
36428         "title": "Example usage:",
36429         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36430         "type": "json"
36431       }
36432     ],
36433     "name": "updateInteractions",
36434     "group": "Whatsapp_Interactions",
36435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36436     "version": "0.0.0",
36437     "filename": "server/api/whatsappInteraction/index.js",
36438     "groupTitle": "Whatsapp_Interactions"
36439   },
36440   {
36441     "type": "post",
36442     "url": "/api/whatsapp/messages",
36443     "title": "Creates a new Message",
36444     "examples": [
36445       {
36446         "title": "Example usage:",
36447         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36448         "type": "json"
36449       }
36450     ],
36451     "name": "CreateMessages",
36452     "group": "Whatsapp_Messages",
36453     "parameter": {
36454       "fields": {
36455         "Body": [
36456           {
36457             "group": "Body",
36458             "type": "Text",
36459             "optional": false,
36460             "field": "body",
36461             "description": ""
36462           },
36463           {
36464             "group": "Body",
36465             "type": "Boolean",
36466             "optional": true,
36467             "field": "read",
36468             "description": ""
36469           },
36470           {
36471             "group": "Body",
36472             "type": "String",
36473             "allowedValues": [
36474               "\"in\"",
36475               "\"out\""
36476             ],
36477             "optional": false,
36478             "field": "direction",
36479             "description": ""
36480           },
36481           {
36482             "group": "Body",
36483             "type": "String",
36484             "optional": true,
36485             "field": "messageId",
36486             "description": ""
36487           },
36488           {
36489             "group": "Body",
36490             "type": "String",
36491             "optional": true,
36492             "field": "phone",
36493             "description": ""
36494           },
36495           {
36496             "group": "Body",
36497             "type": "String",
36498             "optional": true,
36499             "field": "readAt",
36500             "description": ""
36501           },
36502           {
36503             "group": "Body",
36504             "type": "Boolean",
36505             "optional": true,
36506             "field": "secret",
36507             "description": ""
36508           },
36509           {
36510             "group": "Body",
36511             "type": "String",
36512             "optional": true,
36513             "field": "providerName",
36514             "description": ""
36515           },
36516           {
36517             "group": "Body",
36518             "type": "Text",
36519             "optional": true,
36520             "field": "providerResponse",
36521             "description": ""
36522           }
36523         ]
36524       }
36525     },
36526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36527     "version": "0.0.0",
36528     "filename": "server/api/whatsappMessage/index.js",
36529     "groupTitle": "Whatsapp_Messages"
36530   },
36531   {
36532     "type": "delete",
36533     "url": "/api/whatsapp/messages/{id}",
36534     "title": "Deletes a Message",
36535     "examples": [
36536       {
36537         "title": "Example usage:",
36538         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36539         "type": "json"
36540       }
36541     ],
36542     "name": "DeleteMessages",
36543     "group": "Whatsapp_Messages",
36544     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36545     "version": "0.0.0",
36546     "filename": "server/api/whatsappMessage/index.js",
36547     "groupTitle": "Whatsapp_Messages"
36548   },
36549   {
36550     "type": "get",
36551     "url": "/api/whatsapp/messages/describe",
36552     "title": "Gets table info about Messages",
36553     "examples": [
36554       {
36555         "title": "Example usage:",
36556         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36557         "type": "json"
36558       }
36559     ],
36560     "name": "DescribeMessages",
36561     "group": "Whatsapp_Messages",
36562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36563     "version": "0.0.0",
36564     "filename": "server/api/whatsappMessage/index.js",
36565     "groupTitle": "Whatsapp_Messages"
36566   },
36567   {
36568     "type": "get",
36569     "url": "/api/whatsapp/messages",
36570     "title": "Gets a list of Messages",
36571     "examples": [
36572       {
36573         "title": "Example usage:",
36574         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36575         "type": "json"
36576       }
36577     ],
36578     "name": "GetMessages",
36579     "group": "Whatsapp_Messages",
36580     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36581     "version": "0.0.0",
36582     "filename": "server/api/whatsappMessage/index.js",
36583     "groupTitle": "Whatsapp_Messages"
36584   },
36585   {
36586     "type": "get",
36587     "url": "/api/whatsapp/messages/{id}",
36588     "title": "Gets a single Message",
36589     "examples": [
36590       {
36591         "title": "Example usage:",
36592         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36593         "type": "json"
36594       }
36595     ],
36596     "name": "ShowMessages",
36597     "group": "Whatsapp_Messages",
36598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36599     "version": "0.0.0",
36600     "filename": "server/api/whatsappMessage/index.js",
36601     "groupTitle": "Whatsapp_Messages"
36602   },
36603   {
36604     "type": "put",
36605     "url": "/api/whatsapp/messages/{id}",
36606     "title": "Update an existing Message",
36607     "examples": [
36608       {
36609         "title": "Example usage:",
36610         "content": "curl https://{domain}/api/whatsapp/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36611         "type": "json"
36612       }
36613     ],
36614     "name": "updateMessages",
36615     "group": "Whatsapp_Messages",
36616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36617     "version": "0.0.0",
36618     "filename": "server/api/whatsappMessage/index.js",
36619     "groupTitle": "Whatsapp_Messages"
36620   },
36621   {
36622     "type": "post",
36623     "url": "/api/whatsapp/reports/queue",
36624     "title": "Creates a new Whatsapp Queue Report",
36625     "examples": [
36626       {
36627         "title": "Example usage:",
36628         "content": "curl https://{domain}/api/whatsapp/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36629         "type": "json"
36630       }
36631     ],
36632     "name": "CreateWhatsapp_Queue_Reports",
36633     "group": "Whatsapp_Queue_Reports",
36634     "parameter": {
36635       "fields": {
36636         "Body": [
36637           {
36638             "group": "Body",
36639             "type": "String",
36640             "optional": false,
36641             "field": "uniqueid",
36642             "description": ""
36643           },
36644           {
36645             "group": "Body",
36646             "type": "String",
36647             "optional": true,
36648             "field": "from",
36649             "description": ""
36650           },
36651           {
36652             "group": "Body",
36653             "type": "String",
36654             "optional": true,
36655             "field": "joinAt",
36656             "description": ""
36657           },
36658           {
36659             "group": "Body",
36660             "type": "String",
36661             "optional": true,
36662             "field": "leaveAt",
36663             "description": ""
36664           },
36665           {
36666             "group": "Body",
36667             "type": "String",
36668             "optional": true,
36669             "field": "acceptAt",
36670             "description": ""
36671           },
36672           {
36673             "group": "Body",
36674             "type": "String",
36675             "optional": true,
36676             "field": "exitAt",
36677             "description": ""
36678           },
36679           {
36680             "group": "Body",
36681             "type": "String",
36682             "optional": true,
36683             "field": "reason",
36684             "description": ""
36685           }
36686         ]
36687       }
36688     },
36689     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36690     "version": "0.0.0",
36691     "filename": "server/api/whatsappQueueReport/index.js",
36692     "groupTitle": "Whatsapp_Queue_Reports"
36693   },
36694   {
36695     "type": "delete",
36696     "url": "/api/whatsapp/reports/queue/{id}",
36697     "title": "Deletes a Whatsapp Queue Report",
36698     "examples": [
36699       {
36700         "title": "Example usage:",
36701         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36702         "type": "json"
36703       }
36704     ],
36705     "name": "DeleteWhatsapp_Queue_Reports",
36706     "group": "Whatsapp_Queue_Reports",
36707     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36708     "version": "0.0.0",
36709     "filename": "server/api/whatsappQueueReport/index.js",
36710     "groupTitle": "Whatsapp_Queue_Reports"
36711   },
36712   {
36713     "type": "get",
36714     "url": "/api/whatsapp/reports/queue/describe",
36715     "title": "Gets table info about Whatsapp Queue Reports",
36716     "examples": [
36717       {
36718         "title": "Example usage:",
36719         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36720         "type": "json"
36721       }
36722     ],
36723     "name": "DescribeWhatsapp_Queue_Reports",
36724     "group": "Whatsapp_Queue_Reports",
36725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36726     "version": "0.0.0",
36727     "filename": "server/api/whatsappQueueReport/index.js",
36728     "groupTitle": "Whatsapp_Queue_Reports"
36729   },
36730   {
36731     "type": "get",
36732     "url": "/api/whatsapp/reports/queue",
36733     "title": "Gets a list of Whatsapp Queue Reports",
36734     "examples": [
36735       {
36736         "title": "Example usage:",
36737         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36738         "type": "json"
36739       }
36740     ],
36741     "name": "GetWhatsapp_Queue_Reports",
36742     "group": "Whatsapp_Queue_Reports",
36743     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36744     "version": "0.0.0",
36745     "filename": "server/api/whatsappQueueReport/index.js",
36746     "groupTitle": "Whatsapp_Queue_Reports"
36747   },
36748   {
36749     "type": "get",
36750     "url": "/api/whatsapp/reports/queue/{id}",
36751     "title": "Gets a single Whatsapp Queue Report",
36752     "examples": [
36753       {
36754         "title": "Example usage:",
36755         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36756         "type": "json"
36757       }
36758     ],
36759     "name": "ShowWhatsapp_Queue_Reports",
36760     "group": "Whatsapp_Queue_Reports",
36761     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36762     "version": "0.0.0",
36763     "filename": "server/api/whatsappQueueReport/index.js",
36764     "groupTitle": "Whatsapp_Queue_Reports"
36765   },
36766   {
36767     "type": "put",
36768     "url": "/api/whatsapp/reports/queue/{id}",
36769     "title": "Update an existing Whatsapp Queue Report",
36770     "examples": [
36771       {
36772         "title": "Example usage:",
36773         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36774         "type": "json"
36775       }
36776     ],
36777     "name": "updateWhatsapp_Queue_Reports",
36778     "group": "Whatsapp_Queue_Reports",
36779     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36780     "version": "0.0.0",
36781     "filename": "server/api/whatsappQueueReport/index.js",
36782     "groupTitle": "Whatsapp_Queue_Reports"
36783   },
36784   {
36785     "type": "post",
36786     "url": "/api/whatsapp/queues/{id}/users",
36787     "title": "Add agents to a queue",
36788     "examples": [
36789       {
36790         "title": "Example usage:",
36791         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36792         "type": "json"
36793       }
36794     ],
36795     "name": "AddAgents",
36796     "group": "Whatsapp_Queues",
36797     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36798     "version": "0.0.0",
36799     "filename": "server/api/whatsappQueue/index.js",
36800     "groupTitle": "Whatsapp_Queues"
36801   },
36802   {
36803     "type": "post",
36804     "url": "/api/whatsapp/queues/{id}/teams",
36805     "title": "Add teams to a queue",
36806     "examples": [
36807       {
36808         "title": "Example usage:",
36809         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36810         "type": "json"
36811       }
36812     ],
36813     "name": "AddTeams",
36814     "group": "Whatsapp_Queues",
36815     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36816     "version": "0.0.0",
36817     "filename": "server/api/whatsappQueue/index.js",
36818     "groupTitle": "Whatsapp_Queues"
36819   },
36820   {
36821     "type": "post",
36822     "url": "/api/whatsapp/queues",
36823     "title": "Creates a new Queue",
36824     "examples": [
36825       {
36826         "title": "Example usage:",
36827         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36828         "type": "json"
36829       }
36830     ],
36831     "name": "CreateQueues",
36832     "group": "Whatsapp_Queues",
36833     "parameter": {
36834       "fields": {
36835         "Body": [
36836           {
36837             "group": "Body",
36838             "type": "String",
36839             "optional": true,
36840             "field": "name",
36841             "description": ""
36842           },
36843           {
36844             "group": "Body",
36845             "type": "Integer",
36846             "optional": true,
36847             "field": "timeout",
36848             "description": ""
36849           },
36850           {
36851             "group": "Body",
36852             "type": "String",
36853             "allowedValues": [
36854               "\"rrmemory\"",
36855               "\"beepall\"",
36856               "\"roundrobin\""
36857             ],
36858             "optional": true,
36859             "field": "strategy",
36860             "description": ""
36861           },
36862           {
36863             "group": "Body",
36864             "type": "String",
36865             "optional": true,
36866             "field": "description",
36867             "description": ""
36868           }
36869         ]
36870       }
36871     },
36872     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36873     "version": "0.0.0",
36874     "filename": "server/api/whatsappQueue/index.js",
36875     "groupTitle": "Whatsapp_Queues"
36876   },
36877   {
36878     "type": "delete",
36879     "url": "/api/whatsapp/queues/{id}",
36880     "title": "Deletes a Queue",
36881     "examples": [
36882       {
36883         "title": "Example usage:",
36884         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36885         "type": "json"
36886       }
36887     ],
36888     "name": "DeleteQueues",
36889     "group": "Whatsapp_Queues",
36890     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36891     "version": "0.0.0",
36892     "filename": "server/api/whatsappQueue/index.js",
36893     "groupTitle": "Whatsapp_Queues"
36894   },
36895   {
36896     "type": "get",
36897     "url": "/api/whatsapp/queues/describe",
36898     "title": "Gets table info about Queues",
36899     "examples": [
36900       {
36901         "title": "Example usage:",
36902         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36903         "type": "json"
36904       }
36905     ],
36906     "name": "DescribeQueues",
36907     "group": "Whatsapp_Queues",
36908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36909     "version": "0.0.0",
36910     "filename": "server/api/whatsappQueue/index.js",
36911     "groupTitle": "Whatsapp_Queues"
36912   },
36913   {
36914     "type": "get",
36915     "url": "/api/whatsapp/queues/{id}/users",
36916     "title": "Gets queue agents",
36917     "examples": [
36918       {
36919         "title": "Example usage:",
36920         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36921         "type": "json"
36922       }
36923     ],
36924     "name": "GetAgents",
36925     "group": "Whatsapp_Queues",
36926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36927     "version": "0.0.0",
36928     "filename": "server/api/whatsappQueue/index.js",
36929     "groupTitle": "Whatsapp_Queues"
36930   },
36931   {
36932     "type": "get",
36933     "url": "/api/whatsapp/queues/{id}/members",
36934     "title": "GetMembers",
36935     "examples": [
36936       {
36937         "title": "Example usage:",
36938         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36939         "type": "json"
36940       }
36941     ],
36942     "name": "GetMembers",
36943     "group": "Whatsapp_Queues",
36944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36945     "version": "0.0.0",
36946     "filename": "server/api/whatsappQueue/index.js",
36947     "groupTitle": "Whatsapp_Queues"
36948   },
36949   {
36950     "type": "get",
36951     "url": "/api/whatsapp/queues",
36952     "title": "Gets a list of Queues",
36953     "examples": [
36954       {
36955         "title": "Example usage:",
36956         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36957         "type": "json"
36958       }
36959     ],
36960     "name": "GetQueues",
36961     "group": "Whatsapp_Queues",
36962     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36963     "version": "0.0.0",
36964     "filename": "server/api/whatsappQueue/index.js",
36965     "groupTitle": "Whatsapp_Queues"
36966   },
36967   {
36968     "type": "get",
36969     "url": "/api/whatsapp/queues/{id}/teams",
36970     "title": "Gets queues list",
36971     "examples": [
36972       {
36973         "title": "Example usage:",
36974         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36975         "type": "json"
36976       }
36977     ],
36978     "name": "GetTeams",
36979     "group": "Whatsapp_Queues",
36980     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36981     "version": "0.0.0",
36982     "filename": "server/api/whatsappQueue/index.js",
36983     "groupTitle": "Whatsapp_Queues"
36984   },
36985   {
36986     "type": "delete",
36987     "url": "/api/whatsapp/queues/{id}/users",
36988     "title": "Removes agents from a queue",
36989     "examples": [
36990       {
36991         "title": "Example usage:",
36992         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36993         "type": "json"
36994       }
36995     ],
36996     "name": "RemoveAgents",
36997     "group": "Whatsapp_Queues",
36998     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36999     "version": "0.0.0",
37000     "filename": "server/api/whatsappQueue/index.js",
37001     "groupTitle": "Whatsapp_Queues"
37002   },
37003   {
37004     "type": "get",
37005     "url": "/api/whatsapp/queues/{id}",
37006     "title": "Gets a single Queue",
37007     "examples": [
37008       {
37009         "title": "Example usage:",
37010         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
37011         "type": "json"
37012       }
37013     ],
37014     "name": "ShowQueues",
37015     "group": "Whatsapp_Queues",
37016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37017     "version": "0.0.0",
37018     "filename": "server/api/whatsappQueue/index.js",
37019     "groupTitle": "Whatsapp_Queues"
37020   },
37021   {
37022     "type": "put",
37023     "url": "/api/whatsapp/queues/{id}",
37024     "title": "Update an existing Queue",
37025     "examples": [
37026       {
37027         "title": "Example usage:",
37028         "content": "curl https://{domain}/api/whatsapp/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37029         "type": "json"
37030       }
37031     ],
37032     "name": "updateQueues",
37033     "group": "Whatsapp_Queues",
37034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37035     "version": "0.0.0",
37036     "filename": "server/api/whatsappQueue/index.js",
37037     "groupTitle": "Whatsapp_Queues"
37038   },
37039   {
37040     "type": "post",
37041     "url": "/api/whatsapp/reports/transfer",
37042     "title": "Creates a new Whatsapp Transfer Report",
37043     "examples": [
37044       {
37045         "title": "Example usage:",
37046         "content": "curl https://{domain}/api/whatsapp/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37047         "type": "json"
37048       }
37049     ],
37050     "name": "CreateWhatsapp_Transfer_Reports",
37051     "group": "Whatsapp_Transfer_Reports",
37052     "parameter": {
37053       "fields": {
37054         "Body": [
37055           {
37056             "group": "Body",
37057             "type": "String",
37058             "optional": false,
37059             "field": "uniqueid",
37060             "description": ""
37061           },
37062           {
37063             "group": "Body",
37064             "type": "String",
37065             "allowedValues": [
37066               "\"account\"",
37067               "\"agent\"",
37068               "\"queue\""
37069             ],
37070             "optional": false,
37071             "field": "type",
37072             "description": ""
37073           },
37074           {
37075             "group": "Body",
37076             "type": "String",
37077             "optional": true,
37078             "field": "transferredAt",
37079             "description": ""
37080           }
37081         ]
37082       }
37083     },
37084     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37085     "version": "0.0.0",
37086     "filename": "server/api/whatsappTransferReport/index.js",
37087     "groupTitle": "Whatsapp_Transfer_Reports"
37088   },
37089   {
37090     "type": "delete",
37091     "url": "/api/whatsapp/reports/transfer/{id}",
37092     "title": "Deletes a Whatsapp Transfer Report",
37093     "examples": [
37094       {
37095         "title": "Example usage:",
37096         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
37097         "type": "json"
37098       }
37099     ],
37100     "name": "DeleteWhatsapp_Transfer_Reports",
37101     "group": "Whatsapp_Transfer_Reports",
37102     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37103     "version": "0.0.0",
37104     "filename": "server/api/whatsappTransferReport/index.js",
37105     "groupTitle": "Whatsapp_Transfer_Reports"
37106   },
37107   {
37108     "type": "get",
37109     "url": "/api/whatsapp/reports/transfer/describe",
37110     "title": "Gets table info about Whatsapp Transfer Reports",
37111     "examples": [
37112       {
37113         "title": "Example usage:",
37114         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
37115         "type": "json"
37116       }
37117     ],
37118     "name": "DescribeWhatsapp_Transfer_Reports",
37119     "group": "Whatsapp_Transfer_Reports",
37120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37121     "version": "0.0.0",
37122     "filename": "server/api/whatsappTransferReport/index.js",
37123     "groupTitle": "Whatsapp_Transfer_Reports"
37124   },
37125   {
37126     "type": "get",
37127     "url": "/api/whatsapp/reports/transfer",
37128     "title": "Gets a list of Whatsapp Transfer Reports",
37129     "examples": [
37130       {
37131         "title": "Example usage:",
37132         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37133         "type": "json"
37134       }
37135     ],
37136     "name": "GetWhatsapp_Transfer_Reports",
37137     "group": "Whatsapp_Transfer_Reports",
37138     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37139     "version": "0.0.0",
37140     "filename": "server/api/whatsappTransferReport/index.js",
37141     "groupTitle": "Whatsapp_Transfer_Reports"
37142   },
37143   {
37144     "type": "get",
37145     "url": "/api/whatsapp/reports/transfer/{id}",
37146     "title": "Gets a single Whatsapp Transfer Report",
37147     "examples": [
37148       {
37149         "title": "Example usage:",
37150         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37151         "type": "json"
37152       }
37153     ],
37154     "name": "ShowWhatsapp_Transfer_Reports",
37155     "group": "Whatsapp_Transfer_Reports",
37156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37157     "version": "0.0.0",
37158     "filename": "server/api/whatsappTransferReport/index.js",
37159     "groupTitle": "Whatsapp_Transfer_Reports"
37160   },
37161   {
37162     "type": "put",
37163     "url": "/api/whatsapp/reports/transfer/{id}",
37164     "title": "Update an existing Whatsapp Transfer Report",
37165     "examples": [
37166       {
37167         "title": "Example usage:",
37168         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37169         "type": "json"
37170       }
37171     ],
37172     "name": "updateWhatsapp_Transfer_Reports",
37173     "group": "Whatsapp_Transfer_Reports",
37174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37175     "version": "0.0.0",
37176     "filename": "server/api/whatsappTransferReport/index.js",
37177     "groupTitle": "Whatsapp_Transfer_Reports"
37178   },
37179   {
37180     "type": "post",
37181     "url": "/api/integrations/zendesk/accounts",
37182     "title": "Creates a new Zendesk Account",
37183     "examples": [
37184       {
37185         "title": "Example usage:",
37186         "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",
37187         "type": "json"
37188       }
37189     ],
37190     "name": "CreateZendesk_Accounts",
37191     "group": "Zendesk_Accounts",
37192     "parameter": {
37193       "fields": {
37194         "Body": [
37195           {
37196             "group": "Body",
37197             "type": "String",
37198             "optional": true,
37199             "field": "name",
37200             "description": ""
37201           },
37202           {
37203             "group": "Body",
37204             "type": "String",
37205             "optional": true,
37206             "field": "description",
37207             "description": ""
37208           },
37209           {
37210             "group": "Body",
37211             "type": "String",
37212             "optional": true,
37213             "field": "username",
37214             "description": ""
37215           },
37216           {
37217             "group": "Body",
37218             "type": "String",
37219             "optional": true,
37220             "field": "password",
37221             "description": ""
37222           },
37223           {
37224             "group": "Body",
37225             "type": "String",
37226             "optional": true,
37227             "field": "token",
37228             "description": ""
37229           },
37230           {
37231             "group": "Body",
37232             "type": "String",
37233             "optional": true,
37234             "field": "remoteUri",
37235             "description": ""
37236           },
37237           {
37238             "group": "Body",
37239             "type": "String",
37240             "allowedValues": [
37241               "\"password\"",
37242               "\"token\""
37243             ],
37244             "optional": true,
37245             "field": "authType",
37246             "description": ""
37247           },
37248           {
37249             "group": "Body",
37250             "type": "String",
37251             "optional": false,
37252             "field": "serverUrl",
37253             "description": ""
37254           },
37255           {
37256             "group": "Body",
37257             "type": "String",
37258             "allowedValues": [
37259               "\"integrationTab\"",
37260               "\"newTab\""
37261             ],
37262             "optional": true,
37263             "field": "type",
37264             "description": ""
37265           }
37266         ]
37267       }
37268     },
37269     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37270     "version": "0.0.0",
37271     "filename": "server/api/intZendeskAccount/index.js",
37272     "groupTitle": "Zendesk_Accounts"
37273   },
37274   {
37275     "type": "delete",
37276     "url": "/api/integrations/zendesk/accounts/{id}",
37277     "title": "Deletes a Zendesk Account",
37278     "examples": [
37279       {
37280         "title": "Example usage:",
37281         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37282         "type": "json"
37283       }
37284     ],
37285     "name": "DeleteZendesk_Accounts",
37286     "group": "Zendesk_Accounts",
37287     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37288     "version": "0.0.0",
37289     "filename": "server/api/intZendeskAccount/index.js",
37290     "groupTitle": "Zendesk_Accounts"
37291   },
37292   {
37293     "type": "get",
37294     "url": "/api/integrations/zendesk/accounts",
37295     "title": "Gets a list of Zendesk Accounts",
37296     "examples": [
37297       {
37298         "title": "Example usage:",
37299         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37300         "type": "json"
37301       }
37302     ],
37303     "name": "GetZendesk_Accounts",
37304     "group": "Zendesk_Accounts",
37305     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37306     "version": "0.0.0",
37307     "filename": "server/api/intZendeskAccount/index.js",
37308     "groupTitle": "Zendesk_Accounts"
37309   },
37310   {
37311     "type": "get",
37312     "url": "/api/integrations/zendesk/accounts/{id}",
37313     "title": "Gets a single Zendesk Account",
37314     "examples": [
37315       {
37316         "title": "Example usage:",
37317         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37318         "type": "json"
37319       }
37320     ],
37321     "name": "ShowZendesk_Accounts",
37322     "group": "Zendesk_Accounts",
37323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37324     "version": "0.0.0",
37325     "filename": "server/api/intZendeskAccount/index.js",
37326     "groupTitle": "Zendesk_Accounts"
37327   },
37328   {
37329     "type": "post",
37330     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37331     "title": "Creates new configuration",
37332     "examples": [
37333       {
37334         "title": "Example usage:",
37335         "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",
37336         "type": "json"
37337       }
37338     ],
37339     "name": "addConfiguration",
37340     "group": "Zendesk_Accounts",
37341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37342     "version": "0.0.0",
37343     "filename": "server/api/intZendeskAccount/index.js",
37344     "groupTitle": "Zendesk_Accounts"
37345   },
37346   {
37347     "type": "get",
37348     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37349     "title": "Gets account configurations",
37350     "examples": [
37351       {
37352         "title": "Example usage:",
37353         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37354         "type": "json"
37355       }
37356     ],
37357     "name": "getConfigurations",
37358     "group": "Zendesk_Accounts",
37359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37360     "version": "0.0.0",
37361     "filename": "server/api/intZendeskAccount/index.js",
37362     "groupTitle": "Zendesk_Accounts"
37363   },
37364   {
37365     "type": "get",
37366     "url": "/api/integrations/zendesk/accounts/{id}/fields",
37367     "title": "Gets account fields",
37368     "examples": [
37369       {
37370         "title": "Example usage:",
37371         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37372         "type": "json"
37373       }
37374     ],
37375     "name": "getFields",
37376     "group": "Zendesk_Accounts",
37377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37378     "version": "0.0.0",
37379     "filename": "server/api/intZendeskAccount/index.js",
37380     "groupTitle": "Zendesk_Accounts"
37381   },
37382   {
37383     "type": "put",
37384     "url": "/api/integrations/zendesk/accounts/{id}",
37385     "title": "Update an existing Zendesk Account",
37386     "examples": [
37387       {
37388         "title": "Example usage:",
37389         "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",
37390         "type": "json"
37391       }
37392     ],
37393     "name": "updateZendesk_Accounts",
37394     "group": "Zendesk_Accounts",
37395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37396     "version": "0.0.0",
37397     "filename": "server/api/intZendeskAccount/index.js",
37398     "groupTitle": "Zendesk_Accounts"
37399   },
37400   {
37401     "type": "post",
37402     "url": "/api/integrations/zendesk/configurations",
37403     "title": "Creates a new Zendesk Configuration",
37404     "examples": [
37405       {
37406         "title": "Example usage:",
37407         "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",
37408         "type": "json"
37409       }
37410     ],
37411     "name": "CreateZendesk_Configurations",
37412     "group": "Zendesk_Configurations",
37413     "parameter": {
37414       "fields": {
37415         "Body": [
37416           {
37417             "group": "Body",
37418             "type": "String",
37419             "optional": true,
37420             "field": "name",
37421             "description": ""
37422           },
37423           {
37424             "group": "Body",
37425             "type": "String",
37426             "optional": true,
37427             "field": "description",
37428             "description": ""
37429           }
37430         ]
37431       }
37432     },
37433     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37434     "version": "0.0.0",
37435     "filename": "server/api/intZendeskConfiguration/index.js",
37436     "groupTitle": "Zendesk_Configurations"
37437   },
37438   {
37439     "type": "delete",
37440     "url": "/api/integrations/zendesk/configurations/{id}",
37441     "title": "Deletes a Zendesk Configuration",
37442     "examples": [
37443       {
37444         "title": "Example usage:",
37445         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37446         "type": "json"
37447       }
37448     ],
37449     "name": "DeleteZendesk_Configurations",
37450     "group": "Zendesk_Configurations",
37451     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37452     "version": "0.0.0",
37453     "filename": "server/api/intZendeskConfiguration/index.js",
37454     "groupTitle": "Zendesk_Configurations"
37455   },
37456   {
37457     "type": "get",
37458     "url": "/api/integrations/zendesk/configurations",
37459     "title": "Gets a list of Zendesk Configurations",
37460     "examples": [
37461       {
37462         "title": "Example usage:",
37463         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37464         "type": "json"
37465       }
37466     ],
37467     "name": "GetZendesk_Configurations",
37468     "group": "Zendesk_Configurations",
37469     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37470     "version": "0.0.0",
37471     "filename": "server/api/intZendeskConfiguration/index.js",
37472     "groupTitle": "Zendesk_Configurations"
37473   },
37474   {
37475     "type": "get",
37476     "url": "/api/integrations/zendesk/configurations/{id}",
37477     "title": "Gets a single Zendesk Configuration",
37478     "examples": [
37479       {
37480         "title": "Example usage:",
37481         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37482         "type": "json"
37483       }
37484     ],
37485     "name": "ShowZendesk_Configurations",
37486     "group": "Zendesk_Configurations",
37487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37488     "version": "0.0.0",
37489     "filename": "server/api/intZendeskConfiguration/index.js",
37490     "groupTitle": "Zendesk_Configurations"
37491   },
37492   {
37493     "type": "get",
37494     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37495     "title": "Gets configurations descriptions",
37496     "examples": [
37497       {
37498         "title": "Example usage:",
37499         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37500         "type": "json"
37501       }
37502     ],
37503     "name": "getDescriptions",
37504     "group": "Zendesk_Configurations",
37505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37506     "version": "0.0.0",
37507     "filename": "server/api/intZendeskConfiguration/index.js",
37508     "groupTitle": "Zendesk_Configurations"
37509   },
37510   {
37511     "type": "get",
37512     "url": "/api/integrations/zendesk/configurations/{id}/fields",
37513     "title": "Gets configurations fields",
37514     "examples": [
37515       {
37516         "title": "Example usage:",
37517         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37518         "type": "json"
37519       }
37520     ],
37521     "name": "getFields",
37522     "group": "Zendesk_Configurations",
37523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37524     "version": "0.0.0",
37525     "filename": "server/api/intZendeskConfiguration/index.js",
37526     "groupTitle": "Zendesk_Configurations"
37527   },
37528   {
37529     "type": "get",
37530     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37531     "title": "Gets configurations subjects",
37532     "examples": [
37533       {
37534         "title": "Example usage:",
37535         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37536         "type": "json"
37537       }
37538     ],
37539     "name": "getSubjects",
37540     "group": "Zendesk_Configurations",
37541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37542     "version": "0.0.0",
37543     "filename": "server/api/intZendeskConfiguration/index.js",
37544     "groupTitle": "Zendesk_Configurations"
37545   },
37546   {
37547     "type": "get",
37548     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37549     "title": "Gets configurations tags",
37550     "examples": [
37551       {
37552         "title": "Example usage:",
37553         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37554         "type": "json"
37555       }
37556     ],
37557     "name": "getTags",
37558     "group": "Zendesk_Configurations",
37559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37560     "version": "0.0.0",
37561     "filename": "server/api/intZendeskConfiguration/index.js",
37562     "groupTitle": "Zendesk_Configurations"
37563   },
37564   {
37565     "type": "post",
37566     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37567     "title": "Sets new tags",
37568     "examples": [
37569       {
37570         "title": "Example usage:",
37571         "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",
37572         "type": "json"
37573       }
37574     ],
37575     "name": "setTags",
37576     "group": "Zendesk_Configurations",
37577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37578     "version": "0.0.0",
37579     "filename": "server/api/intZendeskConfiguration/index.js",
37580     "groupTitle": "Zendesk_Configurations"
37581   },
37582   {
37583     "type": "put",
37584     "url": "/api/integrations/zendesk/configurations/{id}",
37585     "title": "Update an existing Zendesk Configuration",
37586     "examples": [
37587       {
37588         "title": "Example usage:",
37589         "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",
37590         "type": "json"
37591       }
37592     ],
37593     "name": "updateZendesk_Configurations",
37594     "group": "Zendesk_Configurations",
37595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37596     "version": "0.0.0",
37597     "filename": "server/api/intZendeskConfiguration/index.js",
37598     "groupTitle": "Zendesk_Configurations"
37599   },
37600   {
37601     "type": "post",
37602     "url": "/api/integrations/zendesk/fields",
37603     "title": "Creates a new Zendesk Field",
37604     "examples": [
37605       {
37606         "title": "Example usage:",
37607         "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",
37608         "type": "json"
37609       }
37610     ],
37611     "name": "CreateZendesk_Fields",
37612     "group": "Zendesk_Fields",
37613     "parameter": {
37614       "fields": {
37615         "Body": [
37616           {
37617             "group": "Body",
37618             "type": "String",
37619             "allowedValues": [
37620               "\"string\"",
37621               "\"variable\"",
37622               "\"customVariable\"",
37623               "\"keyValue\"",
37624               "\"picklist\""
37625             ],
37626             "optional": true,
37627             "field": "type",
37628             "description": ""
37629           },
37630           {
37631             "group": "Body",
37632             "type": "String",
37633             "optional": true,
37634             "field": "content",
37635             "description": ""
37636           },
37637           {
37638             "group": "Body",
37639             "type": "String",
37640             "optional": true,
37641             "field": "key",
37642             "description": ""
37643           },
37644           {
37645             "group": "Body",
37646             "type": "String",
37647             "allowedValues": [
37648               "\"string\"",
37649               "\"variable\"",
37650               "\"customVariable\""
37651             ],
37652             "optional": true,
37653             "field": "keyType",
37654             "description": ""
37655           },
37656           {
37657             "group": "Body",
37658             "type": "String",
37659             "optional": true,
37660             "field": "keyContent",
37661             "description": ""
37662           },
37663           {
37664             "group": "Body",
37665             "type": "String",
37666             "optional": true,
37667             "field": "idField",
37668             "description": ""
37669           },
37670           {
37671             "group": "Body",
37672             "type": "String",
37673             "optional": true,
37674             "field": "nameField",
37675             "description": ""
37676           },
37677           {
37678             "group": "Body",
37679             "type": "Boolean",
37680             "optional": true,
37681             "field": "customField",
37682             "description": ""
37683           },
37684           {
37685             "group": "Body",
37686             "type": "String",
37687             "optional": true,
37688             "field": "variableName",
37689             "description": ""
37690           }
37691         ]
37692       }
37693     },
37694     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37695     "version": "0.0.0",
37696     "filename": "server/api/intZendeskField/index.js",
37697     "groupTitle": "Zendesk_Fields"
37698   },
37699   {
37700     "type": "delete",
37701     "url": "/api/integrations/zendesk/fields/{id}",
37702     "title": "Deletes a Zendesk Field",
37703     "examples": [
37704       {
37705         "title": "Example usage:",
37706         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37707         "type": "json"
37708       }
37709     ],
37710     "name": "DeleteZendesk_Fields",
37711     "group": "Zendesk_Fields",
37712     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37713     "version": "0.0.0",
37714     "filename": "server/api/intZendeskField/index.js",
37715     "groupTitle": "Zendesk_Fields"
37716   },
37717   {
37718     "type": "get",
37719     "url": "/api/integrations/zendesk/fields",
37720     "title": "Gets a list of Zendesk Fields",
37721     "examples": [
37722       {
37723         "title": "Example usage:",
37724         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37725         "type": "json"
37726       }
37727     ],
37728     "name": "GetZendesk_Fields",
37729     "group": "Zendesk_Fields",
37730     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37731     "version": "0.0.0",
37732     "filename": "server/api/intZendeskField/index.js",
37733     "groupTitle": "Zendesk_Fields"
37734   },
37735   {
37736     "type": "get",
37737     "url": "/api/integrations/zendesk/fields/{id}",
37738     "title": "Gets a single Zendesk Field",
37739     "examples": [
37740       {
37741         "title": "Example usage:",
37742         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37743         "type": "json"
37744       }
37745     ],
37746     "name": "ShowZendesk_Fields",
37747     "group": "Zendesk_Fields",
37748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37749     "version": "0.0.0",
37750     "filename": "server/api/intZendeskField/index.js",
37751     "groupTitle": "Zendesk_Fields"
37752   },
37753   {
37754     "type": "put",
37755     "url": "/api/integrations/zendesk/fields/{id}",
37756     "title": "Update an existing Zendesk Field",
37757     "examples": [
37758       {
37759         "title": "Example usage:",
37760         "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",
37761         "type": "json"
37762       }
37763     ],
37764     "name": "updateZendesk_Fields",
37765     "group": "Zendesk_Fields",
37766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37767     "version": "0.0.0",
37768     "filename": "server/api/intZendeskField/index.js",
37769     "groupTitle": "Zendesk_Fields"
37770   },
37771   {
37772     "type": "post",
37773     "url": "/api/integrations/zoho/accounts",
37774     "title": "Creates a new Zoho Account",
37775     "examples": [
37776       {
37777         "title": "Example usage:",
37778         "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",
37779         "type": "json"
37780       }
37781     ],
37782     "name": "CreateZoho_Accounts",
37783     "group": "Zoho_Accounts",
37784     "parameter": {
37785       "fields": {
37786         "Body": [
37787           {
37788             "group": "Body",
37789             "type": "String",
37790             "optional": true,
37791             "field": "name",
37792             "description": ""
37793           },
37794           {
37795             "group": "Body",
37796             "type": "String",
37797             "optional": true,
37798             "field": "description",
37799             "description": ""
37800           },
37801           {
37802             "group": "Body",
37803             "type": "String",
37804             "optional": true,
37805             "field": "host",
37806             "description": ""
37807           },
37808           {
37809             "group": "Body",
37810             "type": "String",
37811             "optional": true,
37812             "field": "zone",
37813             "description": ""
37814           },
37815           {
37816             "group": "Body",
37817             "type": "String",
37818             "optional": true,
37819             "field": "clientId",
37820             "description": ""
37821           },
37822           {
37823             "group": "Body",
37824             "type": "String",
37825             "optional": true,
37826             "field": "clientSecret",
37827             "description": ""
37828           },
37829           {
37830             "group": "Body",
37831             "type": "String",
37832             "optional": false,
37833             "field": "serverUrl",
37834             "description": ""
37835           },
37836           {
37837             "group": "Body",
37838             "type": "String",
37839             "optional": true,
37840             "field": "code",
37841             "description": ""
37842           },
37843           {
37844             "group": "Body",
37845             "type": "String",
37846             "optional": true,
37847             "field": "refreshToken",
37848             "description": ""
37849           }
37850         ]
37851       }
37852     },
37853     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37854     "version": "0.0.0",
37855     "filename": "server/api/intZohoAccount/index.js",
37856     "groupTitle": "Zoho_Accounts"
37857   },
37858   {
37859     "type": "delete",
37860     "url": "/api/integrations/zoho/accounts/{id}",
37861     "title": "Deletes a Zoho Account",
37862     "examples": [
37863       {
37864         "title": "Example usage:",
37865         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37866         "type": "json"
37867       }
37868     ],
37869     "name": "DeleteZoho_Accounts",
37870     "group": "Zoho_Accounts",
37871     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37872     "version": "0.0.0",
37873     "filename": "server/api/intZohoAccount/index.js",
37874     "groupTitle": "Zoho_Accounts"
37875   },
37876   {
37877     "type": "get",
37878     "url": "/api/integrations/zoho/accounts",
37879     "title": "Gets a list of Zoho Accounts",
37880     "examples": [
37881       {
37882         "title": "Example usage:",
37883         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37884         "type": "json"
37885       }
37886     ],
37887     "name": "GetZoho_Accounts",
37888     "group": "Zoho_Accounts",
37889     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37890     "version": "0.0.0",
37891     "filename": "server/api/intZohoAccount/index.js",
37892     "groupTitle": "Zoho_Accounts"
37893   },
37894   {
37895     "type": "get",
37896     "url": "/api/integrations/zoho/accounts/{id}",
37897     "title": "Gets a single Zoho Account",
37898     "examples": [
37899       {
37900         "title": "Example usage:",
37901         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37902         "type": "json"
37903       }
37904     ],
37905     "name": "ShowZoho_Accounts",
37906     "group": "Zoho_Accounts",
37907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37908     "version": "0.0.0",
37909     "filename": "server/api/intZohoAccount/index.js",
37910     "groupTitle": "Zoho_Accounts"
37911   },
37912   {
37913     "type": "post",
37914     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37915     "title": "Creates new configuration",
37916     "examples": [
37917       {
37918         "title": "Example usage:",
37919         "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",
37920         "type": "json"
37921       }
37922     ],
37923     "name": "addConfiguration",
37924     "group": "Zoho_Accounts",
37925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37926     "version": "0.0.0",
37927     "filename": "server/api/intZohoAccount/index.js",
37928     "groupTitle": "Zoho_Accounts"
37929   },
37930   {
37931     "type": "get",
37932     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37933     "title": "Gets account configurations",
37934     "examples": [
37935       {
37936         "title": "Example usage:",
37937         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37938         "type": "json"
37939       }
37940     ],
37941     "name": "getConfigurations",
37942     "group": "Zoho_Accounts",
37943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37944     "version": "0.0.0",
37945     "filename": "server/api/intZohoAccount/index.js",
37946     "groupTitle": "Zoho_Accounts"
37947   },
37948   {
37949     "type": "get",
37950     "url": "/api/integrations/zoho/accounts/{id}/fields",
37951     "title": "Gets account fields",
37952     "examples": [
37953       {
37954         "title": "Example usage:",
37955         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37956         "type": "json"
37957       }
37958     ],
37959     "name": "getFields",
37960     "group": "Zoho_Accounts",
37961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37962     "version": "0.0.0",
37963     "filename": "server/api/intZohoAccount/index.js",
37964     "groupTitle": "Zoho_Accounts"
37965   },
37966   {
37967     "type": "put",
37968     "url": "/api/integrations/zoho/accounts/{id}",
37969     "title": "Update an existing Zoho Account",
37970     "examples": [
37971       {
37972         "title": "Example usage:",
37973         "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",
37974         "type": "json"
37975       }
37976     ],
37977     "name": "updateZoho_Accounts",
37978     "group": "Zoho_Accounts",
37979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37980     "version": "0.0.0",
37981     "filename": "server/api/intZohoAccount/index.js",
37982     "groupTitle": "Zoho_Accounts"
37983   },
37984   {
37985     "type": "post",
37986     "url": "/api/integrations/zoho/configurations",
37987     "title": "Creates a new Zoho Configuration",
37988     "examples": [
37989       {
37990         "title": "Example usage:",
37991         "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",
37992         "type": "json"
37993       }
37994     ],
37995     "name": "CreateZoho_Configurations",
37996     "group": "Zoho_Configurations",
37997     "parameter": {
37998       "fields": {
37999         "Body": [
38000           {
38001             "group": "Body",
38002             "type": "String",
38003             "optional": true,
38004             "field": "name",
38005             "description": ""
38006           },
38007           {
38008             "group": "Body",
38009             "type": "String",
38010             "allowedValues": [
38011               "\"lead\"",
38012               "\"contact\"",
38013               "\"nothing\""
38014             ],
38015             "optional": true,
38016             "field": "moduleCreate",
38017             "description": ""
38018           },
38019           {
38020             "group": "Body",
38021             "type": "String",
38022             "allowedValues": [
38023               "\"contact_lead\"",
38024               "\"contact\"",
38025               "\"lead\""
38026             ],
38027             "optional": true,
38028             "field": "moduleSearch",
38029             "description": ""
38030           },
38031           {
38032             "group": "Body",
38033             "type": "String",
38034             "optional": true,
38035             "field": "description",
38036             "description": ""
38037           }
38038         ]
38039       }
38040     },
38041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38042     "version": "0.0.0",
38043     "filename": "server/api/intZohoConfiguration/index.js",
38044     "groupTitle": "Zoho_Configurations"
38045   },
38046   {
38047     "type": "delete",
38048     "url": "/api/integrations/zoho/configurations/{id}",
38049     "title": "Deletes a Zoho Configuration",
38050     "examples": [
38051       {
38052         "title": "Example usage:",
38053         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
38054         "type": "json"
38055       }
38056     ],
38057     "name": "DeleteZoho_Configurations",
38058     "group": "Zoho_Configurations",
38059     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38060     "version": "0.0.0",
38061     "filename": "server/api/intZohoConfiguration/index.js",
38062     "groupTitle": "Zoho_Configurations"
38063   },
38064   {
38065     "type": "get",
38066     "url": "/api/integrations/zoho/configurations",
38067     "title": "Gets a list of Zoho Configurations",
38068     "examples": [
38069       {
38070         "title": "Example usage:",
38071         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
38072         "type": "json"
38073       }
38074     ],
38075     "name": "GetZoho_Configurations",
38076     "group": "Zoho_Configurations",
38077     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38078     "version": "0.0.0",
38079     "filename": "server/api/intZohoConfiguration/index.js",
38080     "groupTitle": "Zoho_Configurations"
38081   },
38082   {
38083     "type": "get",
38084     "url": "/api/integrations/zoho/configurations/{id}",
38085     "title": "Gets a single Zoho Configuration",
38086     "examples": [
38087       {
38088         "title": "Example usage:",
38089         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
38090         "type": "json"
38091       }
38092     ],
38093     "name": "ShowZoho_Configurations",
38094     "group": "Zoho_Configurations",
38095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38096     "version": "0.0.0",
38097     "filename": "server/api/intZohoConfiguration/index.js",
38098     "groupTitle": "Zoho_Configurations"
38099   },
38100   {
38101     "type": "get",
38102     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
38103     "title": "Gets configurations descriptions",
38104     "examples": [
38105       {
38106         "title": "Example usage:",
38107         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
38108         "type": "json"
38109       }
38110     ],
38111     "name": "getDescriptions",
38112     "group": "Zoho_Configurations",
38113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38114     "version": "0.0.0",
38115     "filename": "server/api/intZohoConfiguration/index.js",
38116     "groupTitle": "Zoho_Configurations"
38117   },
38118   {
38119     "type": "get",
38120     "url": "/api/integrations/zoho/configurations/{id}/fields",
38121     "title": "Gets configurations fields",
38122     "examples": [
38123       {
38124         "title": "Example usage:",
38125         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38126         "type": "json"
38127       }
38128     ],
38129     "name": "getFields",
38130     "group": "Zoho_Configurations",
38131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38132     "version": "0.0.0",
38133     "filename": "server/api/intZohoConfiguration/index.js",
38134     "groupTitle": "Zoho_Configurations"
38135   },
38136   {
38137     "type": "get",
38138     "url": "/api/integrations/zoho/configurations/{id}/subjects",
38139     "title": "Gets configurations subjects",
38140     "examples": [
38141       {
38142         "title": "Example usage:",
38143         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38144         "type": "json"
38145       }
38146     ],
38147     "name": "getSubjects",
38148     "group": "Zoho_Configurations",
38149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38150     "version": "0.0.0",
38151     "filename": "server/api/intZohoConfiguration/index.js",
38152     "groupTitle": "Zoho_Configurations"
38153   },
38154   {
38155     "type": "put",
38156     "url": "/api/integrations/zoho/configurations/{id}",
38157     "title": "Update an existing Zoho Configuration",
38158     "examples": [
38159       {
38160         "title": "Example usage:",
38161         "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",
38162         "type": "json"
38163       }
38164     ],
38165     "name": "updateZoho_Configurations",
38166     "group": "Zoho_Configurations",
38167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38168     "version": "0.0.0",
38169     "filename": "server/api/intZohoConfiguration/index.js",
38170     "groupTitle": "Zoho_Configurations"
38171   },
38172   {
38173     "type": "post",
38174     "url": "/api/integrations/zoho/fields",
38175     "title": "Creates a new Zoho Field",
38176     "examples": [
38177       {
38178         "title": "Example usage:",
38179         "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",
38180         "type": "json"
38181       }
38182     ],
38183     "name": "CreateZoho_Fields",
38184     "group": "Zoho_Fields",
38185     "parameter": {
38186       "fields": {
38187         "Body": [
38188           {
38189             "group": "Body",
38190             "type": "String",
38191             "allowedValues": [
38192               "\"string\"",
38193               "\"variable\"",
38194               "\"customVariable\"",
38195               "\"keyValue\"",
38196               "\"picklist\""
38197             ],
38198             "optional": true,
38199             "field": "type",
38200             "description": ""
38201           },
38202           {
38203             "group": "Body",
38204             "type": "String",
38205             "optional": true,
38206             "field": "content",
38207             "description": ""
38208           },
38209           {
38210             "group": "Body",
38211             "type": "String",
38212             "optional": true,
38213             "field": "key",
38214             "description": ""
38215           },
38216           {
38217             "group": "Body",
38218             "type": "String",
38219             "allowedValues": [
38220               "\"string\"",
38221               "\"variable\"",
38222               "\"customVariable\""
38223             ],
38224             "optional": true,
38225             "field": "keyType",
38226             "description": ""
38227           },
38228           {
38229             "group": "Body",
38230             "type": "String",
38231             "optional": true,
38232             "field": "keyContent",
38233             "description": ""
38234           },
38235           {
38236             "group": "Body",
38237             "type": "String",
38238             "optional": true,
38239             "field": "idField",
38240             "description": ""
38241           },
38242           {
38243             "group": "Body",
38244             "type": "String",
38245             "optional": true,
38246             "field": "nameField",
38247             "description": ""
38248           },
38249           {
38250             "group": "Body",
38251             "type": "Boolean",
38252             "optional": true,
38253             "field": "customField",
38254             "description": ""
38255           },
38256           {
38257             "group": "Body",
38258             "type": "String",
38259             "optional": true,
38260             "field": "variableName",
38261             "description": ""
38262           }
38263         ]
38264       }
38265     },
38266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38267     "version": "0.0.0",
38268     "filename": "server/api/intZohoField/index.js",
38269     "groupTitle": "Zoho_Fields"
38270   },
38271   {
38272     "type": "delete",
38273     "url": "/api/integrations/zoho/fields/{id}",
38274     "title": "Deletes a Zoho Field",
38275     "examples": [
38276       {
38277         "title": "Example usage:",
38278         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38279         "type": "json"
38280       }
38281     ],
38282     "name": "DeleteZoho_Fields",
38283     "group": "Zoho_Fields",
38284     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38285     "version": "0.0.0",
38286     "filename": "server/api/intZohoField/index.js",
38287     "groupTitle": "Zoho_Fields"
38288   },
38289   {
38290     "type": "get",
38291     "url": "/api/integrations/zoho/fields",
38292     "title": "Gets a list of Zoho Fields",
38293     "examples": [
38294       {
38295         "title": "Example usage:",
38296         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38297         "type": "json"
38298       }
38299     ],
38300     "name": "GetZoho_Fields",
38301     "group": "Zoho_Fields",
38302     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38303     "version": "0.0.0",
38304     "filename": "server/api/intZohoField/index.js",
38305     "groupTitle": "Zoho_Fields"
38306   },
38307   {
38308     "type": "get",
38309     "url": "/api/integrations/zoho/fields/{id}",
38310     "title": "Gets a single Zoho Field",
38311     "examples": [
38312       {
38313         "title": "Example usage:",
38314         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38315         "type": "json"
38316       }
38317     ],
38318     "name": "ShowZoho_Fields",
38319     "group": "Zoho_Fields",
38320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38321     "version": "0.0.0",
38322     "filename": "server/api/intZohoField/index.js",
38323     "groupTitle": "Zoho_Fields"
38324   },
38325   {
38326     "type": "put",
38327     "url": "/api/integrations/zoho/fields/{id}",
38328     "title": "Update an existing Zoho Field",
38329     "examples": [
38330       {
38331         "title": "Example usage:",
38332         "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",
38333         "type": "json"
38334       }
38335     ],
38336     "name": "updateZoho_Fields",
38337     "group": "Zoho_Fields",
38338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38339     "version": "0.0.0",
38340     "filename": "server/api/intZohoField/index.js",
38341     "groupTitle": "Zoho_Fields"
38342   },
38343   {
38344     "type": "post",
38345     "url": "/api/cdr",
38346     "title": "Creates a new Cdr",
38347     "examples": [
38348       {
38349         "title": "Example usage:",
38350         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38351         "type": "json"
38352       }
38353     ],
38354     "name": "CreateCdrs",
38355     "group": "cdr",
38356     "parameter": {
38357       "fields": {
38358         "Body": [
38359           {
38360             "group": "Body",
38361             "type": "String",
38362             "optional": false,
38363             "field": "calldate",
38364             "description": ""
38365           },
38366           {
38367             "group": "Body",
38368             "type": "String",
38369             "optional": true,
38370             "field": "clid",
38371             "description": ""
38372           },
38373           {
38374             "group": "Body",
38375             "type": "String",
38376             "optional": true,
38377             "field": "src",
38378             "description": ""
38379           },
38380           {
38381             "group": "Body",
38382             "type": "String",
38383             "optional": true,
38384             "field": "dst",
38385             "description": ""
38386           },
38387           {
38388             "group": "Body",
38389             "type": "String",
38390             "optional": true,
38391             "field": "dcontext",
38392             "description": ""
38393           },
38394           {
38395             "group": "Body",
38396             "type": "String",
38397             "optional": true,
38398             "field": "channel",
38399             "description": ""
38400           },
38401           {
38402             "group": "Body",
38403             "type": "String",
38404             "optional": true,
38405             "field": "dstchannel",
38406             "description": ""
38407           },
38408           {
38409             "group": "Body",
38410             "type": "String",
38411             "optional": true,
38412             "field": "lastapp",
38413             "description": ""
38414           },
38415           {
38416             "group": "Body",
38417             "type": "String",
38418             "optional": true,
38419             "field": "lastdata",
38420             "description": ""
38421           },
38422           {
38423             "group": "Body",
38424             "type": "Integer",
38425             "optional": false,
38426             "field": "duration",
38427             "description": ""
38428           },
38429           {
38430             "group": "Body",
38431             "type": "Integer",
38432             "optional": false,
38433             "field": "billsec",
38434             "description": ""
38435           },
38436           {
38437             "group": "Body",
38438             "type": "String",
38439             "optional": true,
38440             "field": "disposition",
38441             "description": ""
38442           },
38443           {
38444             "group": "Body",
38445             "type": "Integer",
38446             "optional": false,
38447             "field": "amaflags",
38448             "description": ""
38449           },
38450           {
38451             "group": "Body",
38452             "type": "String",
38453             "optional": true,
38454             "field": "accountcode",
38455             "description": ""
38456           },
38457           {
38458             "group": "Body",
38459             "type": "String",
38460             "optional": true,
38461             "field": "userfield",
38462             "description": ""
38463           },
38464           {
38465             "group": "Body",
38466             "type": "String",
38467             "optional": true,
38468             "field": "uniqueid",
38469             "description": ""
38470           },
38471           {
38472             "group": "Body",
38473             "type": "String",
38474             "optional": true,
38475             "field": "linkedid",
38476             "description": ""
38477           },
38478           {
38479             "group": "Body",
38480             "type": "String",
38481             "optional": true,
38482             "field": "sequence",
38483             "description": ""
38484           },
38485           {
38486             "group": "Body",
38487             "type": "String",
38488             "optional": true,
38489             "field": "peeraccount",
38490             "description": ""
38491           },
38492           {
38493             "group": "Body",
38494             "type": "String",
38495             "optional": true,
38496             "field": "type",
38497             "description": ""
38498           },
38499           {
38500             "group": "Body",
38501             "type": "String",
38502             "optional": true,
38503             "field": "tag",
38504             "description": ""
38505           }
38506         ]
38507       }
38508     },
38509     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38510     "version": "0.0.0",
38511     "filename": "server/api/cdr/index.js",
38512     "groupTitle": "cdr"
38513   },
38514   {
38515     "type": "delete",
38516     "url": "/api/cdr/{id}",
38517     "title": "Deletes a Cdr",
38518     "examples": [
38519       {
38520         "title": "Example usage:",
38521         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38522         "type": "json"
38523       }
38524     ],
38525     "name": "DeleteCdrs",
38526     "group": "cdr",
38527     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38528     "version": "0.0.0",
38529     "filename": "server/api/cdr/index.js",
38530     "groupTitle": "cdr"
38531   },
38532   {
38533     "type": "get",
38534     "url": "/api/cdr/describe",
38535     "title": "Gets table info about Cdrs",
38536     "examples": [
38537       {
38538         "title": "Example usage:",
38539         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38540         "type": "json"
38541       }
38542     ],
38543     "name": "DescribeCdrs",
38544     "group": "cdr",
38545     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38546     "version": "0.0.0",
38547     "filename": "server/api/cdr/index.js",
38548     "groupTitle": "cdr"
38549   },
38550   {
38551     "type": "get",
38552     "url": "/api/cdr",
38553     "title": "Gets a list of Cdrs",
38554     "examples": [
38555       {
38556         "title": "Example usage:",
38557         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38558         "type": "json"
38559       }
38560     ],
38561     "name": "GetCdrs",
38562     "group": "cdr",
38563     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38564     "version": "0.0.0",
38565     "filename": "server/api/cdr/index.js",
38566     "groupTitle": "cdr"
38567   },
38568   {
38569     "type": "get",
38570     "url": "/api/cdr/{id}",
38571     "title": "Gets a single Cdr",
38572     "examples": [
38573       {
38574         "title": "Example usage:",
38575         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38576         "type": "json"
38577       }
38578     ],
38579     "name": "ShowCdrs",
38580     "group": "cdr",
38581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38582     "version": "0.0.0",
38583     "filename": "server/api/cdr/index.js",
38584     "groupTitle": "cdr"
38585   },
38586   {
38587     "type": "put",
38588     "url": "/api/cdr/{id}",
38589     "title": "Update an existing Cdr",
38590     "examples": [
38591       {
38592         "title": "Example usage:",
38593         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38594         "type": "json"
38595       }
38596     ],
38597     "name": "updateCdrs",
38598     "group": "cdr",
38599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38600     "version": "0.0.0",
38601     "filename": "server/api/cdr/index.js",
38602     "groupTitle": "cdr"
38603   },
38604   {
38605     "type": "post",
38606     "url": "/api/voiceQueuesLog",
38607     "title": "Creates a new VoiceQueuesLog",
38608     "examples": [
38609       {
38610         "title": "Example usage:",
38611         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38612         "type": "json"
38613       }
38614     ],
38615     "name": "CreateVoiceQueuesLogs",
38616     "group": "voiceQueuesLog",
38617     "parameter": {
38618       "fields": {
38619         "Body": [
38620           {
38621             "group": "Body",
38622             "type": "String",
38623             "optional": true,
38624             "field": "time",
38625             "description": ""
38626           },
38627           {
38628             "group": "Body",
38629             "type": "String",
38630             "optional": false,
38631             "field": "callid",
38632             "description": ""
38633           },
38634           {
38635             "group": "Body",
38636             "type": "String",
38637             "optional": false,
38638             "field": "queuename",
38639             "description": ""
38640           },
38641           {
38642             "group": "Body",
38643             "type": "String",
38644             "optional": false,
38645             "field": "agent",
38646             "description": ""
38647           },
38648           {
38649             "group": "Body",
38650             "type": "String",
38651             "optional": false,
38652             "field": "event",
38653             "description": ""
38654           },
38655           {
38656             "group": "Body",
38657             "type": "String",
38658             "optional": false,
38659             "field": "data",
38660             "description": ""
38661           },
38662           {
38663             "group": "Body",
38664             "type": "String",
38665             "optional": false,
38666             "field": "data1",
38667             "description": ""
38668           },
38669           {
38670             "group": "Body",
38671             "type": "String",
38672             "optional": false,
38673             "field": "data2",
38674             "description": ""
38675           },
38676           {
38677             "group": "Body",
38678             "type": "String",
38679             "optional": false,
38680             "field": "data3",
38681             "description": ""
38682           },
38683           {
38684             "group": "Body",
38685             "type": "String",
38686             "optional": false,
38687             "field": "data4",
38688             "description": ""
38689           },
38690           {
38691             "group": "Body",
38692             "type": "String",
38693             "optional": false,
38694             "field": "data5",
38695             "description": ""
38696           },
38697           {
38698             "group": "Body",
38699             "type": "String",
38700             "optional": false,
38701             "field": "dtm",
38702             "description": ""
38703           }
38704         ]
38705       }
38706     },
38707     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38708     "version": "0.0.0",
38709     "filename": "server/api/voiceQueuesLog/index.js",
38710     "groupTitle": "voiceQueuesLog"
38711   },
38712   {
38713     "type": "delete",
38714     "url": "/api/voiceQueuesLog/{id}",
38715     "title": "Deletes a VoiceQueuesLog",
38716     "examples": [
38717       {
38718         "title": "Example usage:",
38719         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38720         "type": "json"
38721       }
38722     ],
38723     "name": "DeleteVoiceQueuesLogs",
38724     "group": "voiceQueuesLog",
38725     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38726     "version": "0.0.0",
38727     "filename": "server/api/voiceQueuesLog/index.js",
38728     "groupTitle": "voiceQueuesLog"
38729   },
38730   {
38731     "type": "get",
38732     "url": "/api/voiceQueuesLog",
38733     "title": "Gets a list of VoiceQueuesLogs",
38734     "examples": [
38735       {
38736         "title": "Example usage:",
38737         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38738         "type": "json"
38739       }
38740     ],
38741     "name": "GetVoiceQueuesLogs",
38742     "group": "voiceQueuesLog",
38743     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38744     "version": "0.0.0",
38745     "filename": "server/api/voiceQueuesLog/index.js",
38746     "groupTitle": "voiceQueuesLog"
38747   },
38748   {
38749     "type": "get",
38750     "url": "/api/voiceQueuesLog/{id}",
38751     "title": "Gets a single VoiceQueuesLog",
38752     "examples": [
38753       {
38754         "title": "Example usage:",
38755         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38756         "type": "json"
38757       }
38758     ],
38759     "name": "ShowVoiceQueuesLogs",
38760     "group": "voiceQueuesLog",
38761     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38762     "version": "0.0.0",
38763     "filename": "server/api/voiceQueuesLog/index.js",
38764     "groupTitle": "voiceQueuesLog"
38765   },
38766   {
38767     "type": "put",
38768     "url": "/api/voiceQueuesLog/{id}",
38769     "title": "Update an existing VoiceQueuesLog",
38770     "examples": [
38771       {
38772         "title": "Example usage:",
38773         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38774         "type": "json"
38775       }
38776     ],
38777     "name": "updateVoiceQueuesLogs",
38778     "group": "voiceQueuesLog",
38779     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38780     "version": "0.0.0",
38781     "filename": "server/api/voiceQueuesLog/index.js",
38782     "groupTitle": "voiceQueuesLog"
38783   }
38784 ] });