-[\r {\r "type": "delete",\r "url": "/api/actions/{id}",\r "title": "Deletes a Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteActions",\r "group": "Actions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/action/index.js",\r "groupTitle": "Actions"\r },\r {\r "type": "put",\r "url": "/api/actions/{id}",\r "title": "Update an existing Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateActions",\r "group": "Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/action/index.js",\r "groupTitle": "Actions"\r },\r {\r "type": "post",\r "url": "/api/analytics/custom_reports",\r "title": "Creates a new Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "conditions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "joins",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Deletes a Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports",\r "title": "Gets a list of Analytic Custom Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Gets a single Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/preview",\r "title": "Report Preview",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "preview",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/query",\r "title": "Report Query SQL",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "query",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/run",\r "title": "Report Run",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Update an existing Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/default_reports",\r "title": "Creates a new Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "conditions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "joins",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Deletes a Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports",\r "title": "Gets a list of Analytic Default Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Gets a single Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/preview",\r "title": "Report Preview",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "preview",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/query",\r "title": "Report Query SQL",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "query",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/run",\r "title": "Report Run",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Update an existing Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/extracted_reports",\r "title": "Creates a new Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "basename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"csv\"",\r "\"pdf\"",\r "\"xlsx\""\r ],\r "optional": false,\r "field": "output",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "savename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "startDate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "endDate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"manual\"",\r "\"scheduled\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "reportId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportType",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Deletes a Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports",\r "title": "Gets a list of Analytic Extacted Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Gets a single Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports/{id}/download",\r "title": "Download Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Update an existing Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports/create_many",\r "title": "Creates many Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "BulkCreateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "function",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "groupBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "orderBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/field_reports/destroy_many?ids={ids}",\r "title": "Deletes many Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "BulkDeleteAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports",\r "title": "Creates a new Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "function",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "groupBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "orderBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Deletes a Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/field_reports",\r "title": "Gets a list of Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Gets a single Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports/{id}/create_many",\r "title": "Rewrite fields set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addFields",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Update an existing Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/metrics",\r "title": "Creates a new Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Metric",\r "group": "Analytic_Metrics",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "metric",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "delete",\r "url": "/api/analytics/metrics/{id}",\r "title": "Deletes a Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "get",\r "url": "/api/analytics/metrics",\r "title": "Gets a list of Analytic Metric",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "get",\r "url": "/api/analytics/metrics/{id}",\r "title": "Gets a single Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "put",\r "url": "/api/analytics/metrics/{id}",\r "title": "Update an existing Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "post",\r "url": "/api/analytics/tree_reports",\r "title": "Creates a new Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "tree",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Deletes a Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/tree_reports",\r "title": "Gets a list of Analytic Tree Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Gets a single Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Update an existing Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "post",\r "url": "/api/attachments/clone",\r "title": "Clone an existing Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CloneAttachments",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "delete",\r "url": "/api/attachments/{id}",\r "title": "Deletes a Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAttachments",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "get",\r "url": "/api/attachments",\r "title": "Gets a list of Attachments",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAttachments",\r "group": "Attachments",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "get",\r "url": "/api/attachments/{id}",\r "title": "Gets a single Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAttachments",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "post",\r "url": "/api/attachments",\r "title": "Add attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "get",\r "url": "/api/attachments/:id/download",\r "title": "Download attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}/attachment_download",\r "title": "Download attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "show",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "put",\r "url": "/api/attachments/{id}",\r "title": "Update an existing Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAttachments",\r "group": "Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/attachment/index.js",\r "groupTitle": "Attachments"\r },\r {\r "type": "post",\r "url": "/api/auth/local/forgot",\r "title": "Creates a new password reset token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_Forgot_Password",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "email",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authLocal/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/auth/local/reset/:token",\r "title": "Reset user password",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_Reset_Password",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authLocal/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/auth/google",\r "title": "Creates a new User token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_login",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authGoogle/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/auth/local",\r "title": "Creates a new User token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_login",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authLocal/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/automations",\r "title": "Creates a new Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAutomations",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "delete",\r "url": "/api/automations/{id}",\r "title": "Deletes a Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations",\r "title": "Gets a list of Automations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAutomations",\r "group": "Automations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}",\r "title": "Gets a single Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/automations/{id}/actions",\r "title": "Creates new actions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addActions",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "action",\r "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "data7",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/automations/{id}/conditions",\r "title": "Creates new conditions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConditions",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}/actions",\r "title": "Gets Automation Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getActions",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}/conditions",\r "title": "Gets Automation Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConditions",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "put",\r "url": "/api/automations/{id}",\r "title": "Update an existing Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/canned_answers",\r "title": "Create a new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "delete",\r "url": "/api/canned_answers/{id}",\r "title": "Deletes a Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/api/canned_answers",\r "title": "Gets a list of Canned Answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/api/canned_answers/{id}",\r "title": "Gets a single Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "put",\r "url": "/api/canned_answers/{id}",\r "title": "Update an existing Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/chat/internal/users",\r "title": "Gets Users Last Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getLastUsersMessages",\r "group": "ChatInternalMessage",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "ChatInternalMessage"\r },\r {\r "type": "delete",\r "url": "/api/chat/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "get",\r "url": "/api/chat/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "put",\r "url": "/api/chat/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "post",\r "url": "/api/chat/groups",\r "title": "Creates a new Group",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateGroups",\r "group": "Chat_Groups",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "write",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "delete",\r "url": "/api/chat/groups/{id}",\r "title": "Deletes a Group",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteGroups",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "get",\r "url": "/api/chat/groups/describe",\r "title": "Gets table info about Groups",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeGroups",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "get",\r "url": "/api/chat/groups",\r "title": "Gets a list of Groups",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetGroups",\r "group": "Chat_Groups",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "delete",\r "url": "/api/chat/groups/{id}/members",\r "title": "Removes members from a group",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveMembers",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "get",\r "url": "/api/chat/groups/{id}",\r "title": "Gets a single Group",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowGroups",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "post",\r "url": "/api/chat/groups/{id}/members",\r "title": "Add members to chat group",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addMembers",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "post",\r "url": "/api/chat/groups/{id}/messages",\r "title": "Creates a new group message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "get",\r "url": "/api/chat/groups/{id}/members",\r "title": "Gets Members",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMembers",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "get",\r "url": "/api/chat/groups/{id}/messages",\r "title": "Gets Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "get",\r "url": "/api/chat/groups/{id}/unread",\r "title": "Get unread chat group messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getUread",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "put",\r "url": "/api/chat/groups/{id}",\r "title": "Update an existing Group",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateGroups",\r "group": "Chat_Groups",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatGroup/index.js",\r "groupTitle": "Chat_Groups"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions/{id}/tags",\r "title": "Add tags to the interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTags",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Chat_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ratingValue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"star\"",\r "\"thumb\""\r ],\r "optional": true,\r "field": "ratingType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "ratingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "pathTranscript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailTranscript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "browserName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "browserVersion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "osName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "osVersion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deviceModel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deviceVendor",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deviceType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "referer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customerIp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "formData",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customerPort",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "vidaooSessionId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/chat/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/chat/interactions/{id}/tags",\r "title": "Removes tags from interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTags",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "put",\r "url": "/api/chat/interactions/{id}/abandon",\r "title": "Abandon interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "abandon",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "put",\r "url": "/api/chat/interactions/{id}/close",\r "title": "Close Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Chat_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions/{id}/attachment_upload",\r "title": "Add attachment",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "attachmentUpload",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions/{id}/vidaoo",\r "title": "Create Vidaoo Session",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "createVidaooSession",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "put",\r "url": "/api/chat/interactions/{id}/custom_update",\r "title": "Update interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "customUpdate",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}/download",\r "title": "Gets interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}/my_messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMyMessages",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "put",\r "url": "/api/chat/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/internal/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Chat_Internal_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ChatInternalMessageId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "Chat_Internal_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/internal/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Chat_Internal_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "Chat_Internal_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/internal/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Chat_Internal_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "Chat_Internal_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/internal/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Chat_Internal_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "Chat_Internal_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/internal/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Chat_Internal_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "Chat_Internal_Messages"\r },\r {\r "type": "put",\r "url": "/api/chat/internal/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Chat_Internal_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInternalMessage/index.js",\r "groupTitle": "Chat_Internal_Messages"\r },\r {\r "type": "post",\r "url": "/api/chat/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Chat_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "put",\r "url": "/api/chat/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "post",\r "url": "/api/chat/offline_messages",\r "title": "Creates a new OfflineMessage",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateOfflineMessages",\r "group": "Chat_Offline_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatOfflineMessage/index.js",\r "groupTitle": "Chat_Offline_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/offline_messages/{id}",\r "title": "Deletes a OfflineMessage",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteOfflineMessages",\r "group": "Chat_Offline_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatOfflineMessage/index.js",\r "groupTitle": "Chat_Offline_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/offline_messages/describe",\r "title": "Gets table info about OfflineMessages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeOfflineMessages",\r "group": "Chat_Offline_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatOfflineMessage/index.js",\r "groupTitle": "Chat_Offline_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/offline_messages",\r "title": "Gets a list of OfflineMessages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetOfflineMessages",\r "group": "Chat_Offline_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatOfflineMessage/index.js",\r "groupTitle": "Chat_Offline_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/offline_messages/{id}",\r "title": "Gets a single OfflineMessage",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowOfflineMessages",\r "group": "Chat_Offline_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatOfflineMessage/index.js",\r "groupTitle": "Chat_Offline_Messages"\r },\r {\r "type": "put",\r "url": "/api/chat/offline_messages/{id}",\r "title": "Update an existing OfflineMessage",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateOfflineMessages",\r "group": "Chat_Offline_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatOfflineMessage/index.js",\r "groupTitle": "Chat_Offline_Messages"\r },\r {\r "type": "post",\r "url": "/api/chat/proactive_actions",\r "title": "Creates a new Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"mouseOver\"",\r "\"timeout\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "selector",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "delete",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Deletes a Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "get",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Gets a single Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "put",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Update an existing Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "post",\r "url": "/api/chat/reports/queue",\r "title": "Creates a new Chat Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateChat_Queue_Reports",\r "group": "Chat_Queue_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueueReport/index.js",\r "groupTitle": "Chat_Queue_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/reports/queue/{id}",\r "title": "Deletes a Chat Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteChat_Queue_Reports",\r "group": "Chat_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueueReport/index.js",\r "groupTitle": "Chat_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/queue/describe",\r "title": "Gets table info about Chat Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeChat_Queue_Reports",\r "group": "Chat_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueueReport/index.js",\r "groupTitle": "Chat_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/queue",\r "title": "Gets a list of Chat Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetChat_Queue_Reports",\r "group": "Chat_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueueReport/index.js",\r "groupTitle": "Chat_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/queue/{id}",\r "title": "Gets a single Chat Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowChat_Queue_Reports",\r "group": "Chat_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueueReport/index.js",\r "groupTitle": "Chat_Queue_Reports"\r },\r {\r "type": "put",\r "url": "/api/chat/reports/queue/{id}",\r "title": "Update an existing Chat Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateChat_Queue_Reports",\r "group": "Chat_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueueReport/index.js",\r "groupTitle": "Chat_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/chat/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Chat_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/describe",\r "title": "Gets table info about Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/members",\r "title": "GetMembers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "put",\r "url": "/api/chat/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/reports/transfer",\r "title": "Creates a new Chat Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateChat_Transfer_Reports",\r "group": "Chat_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"account\"",\r "\"agent\"",\r "\"queue\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "transferredAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatTransferReport/index.js",\r "groupTitle": "Chat_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/reports/transfer/{id}",\r "title": "Deletes a Chat Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteChat_Transfer_Reports",\r "group": "Chat_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatTransferReport/index.js",\r "groupTitle": "Chat_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/transfer/describe",\r "title": "Gets table info about Chat Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeChat_Transfer_Reports",\r "group": "Chat_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatTransferReport/index.js",\r "groupTitle": "Chat_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/transfer",\r "title": "Gets a list of Chat Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetChat_Transfer_Reports",\r "group": "Chat_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatTransferReport/index.js",\r "groupTitle": "Chat_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/transfer/{id}",\r "title": "Gets a single Chat Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowChat_Transfer_Reports",\r "group": "Chat_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatTransferReport/index.js",\r "groupTitle": "Chat_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/chat/reports/transfer/{id}",\r "title": "Update an existing Chat Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateChat_Transfer_Reports",\r "group": "Chat_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatTransferReport/index.js",\r "groupTitle": "Chat_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/users",\r "title": "Add agents to a website",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites",\r "title": "Creates a new Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateWebsites",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mapKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mapKeyOffline",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentAlias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customerAlias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "color",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "color_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "textColor",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fontSize",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "animation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rounded\"",\r "\"squared\""\r ],\r "optional": true,\r "field": "header_shape",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "header_online",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "start_chat_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "offline_chat_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "header_offline",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "download_transcript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "whiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultWhiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "sitepic",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closingQuestion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "formSubmitSuccessMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "formSubmitFailureMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "noteTitle",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "placeholderMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closingMessageButton",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "skipMessageButton",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "conditionAgreement",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableRating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableFeedback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableSendButton",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "feedbackTitle",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"star\"",\r "\"thumb\""\r ],\r "optional": true,\r "field": "ratingType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ratingStarsNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "onlineForm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "offlineForm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "autoclose",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableCustomerWriting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "forwardTranscript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "forwardTranscriptMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "forwardOffline",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "forwardOfflineAddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "waitingTitle",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "waitingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "offlineMessageSubject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "offlineMessageBody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableUnmanagedNote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "unmanagedMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "skipUnmanaged",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sendUnmanaged",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableCustomerAttachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableCustomerCheckmarks",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "agentAvatar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "showAgentAvatar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notificationTemplate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationSound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationShake",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "hideWhenOffline",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentIdentifier",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "waitForTheAssignedAgent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alignment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "verticalAlignment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messagesAlignment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultTitle",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "customerAvatar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "showCustomerAvatar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageFontSize",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "backgroundColor",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "queueTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queueTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "agentTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "systemAlias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "systemAvatar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mandatoryDispositionPauseId",\r "description": "<p>Status to put when mandatory disposition is enabled</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mandatoryDisposition",\r "description": "<p>Enabled/disables mandatory dispo on a queue</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "vidaooEscalation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vidaooApiKey",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "delete",\r "url": "/api/chat/websites/{id}",\r "title": "Deletes a Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/describe",\r "title": "Gets table info about Websites",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/users",\r "title": "Gets agents from website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites",\r "title": "Gets a list of Websites",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "delete",\r "url": "/api/chat/websites/{id}/users",\r "title": "Removes agents from a website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "delete",\r "url": "/api/chat/websites/{id}/canned_answers",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAnswers",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "delete",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}",\r "title": "Gets a single Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "put",\r "url": "/api/chat/messages/{id}/accept",\r "title": "Accepts message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "acceptMessage",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/canned_answers",\r "title": "Creates new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnswer",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/avatar",\r "title": "Add avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAvatar",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/customer_avatar",\r "title": "Add customer avatar",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addCustomerAvatar",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ratingValue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"star\"",\r "\"thumb\""\r ],\r "optional": true,\r "field": "ratingType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "ratingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "pathTranscript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailTranscript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "browserName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "browserVersion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "osName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "osVersion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deviceModel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deviceVendor",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deviceType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "referer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customerIp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "formData",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customerPort",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "vidaooSessionId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/logo",\r "title": "Add logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogo",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/proactive_actions",\r "title": "Creates new Proactive Actions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addProactiveActions",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"mouseOver\"",\r "\"timeout\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "selector",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/system_avatar",\r "title": "Add system avatar",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addSystemAvatar",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/canned_answers",\r "title": "Gets account canned answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/applications",\r "title": "Gets Website Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/avatar",\r "title": "Get avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAvatar",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/customer_avatar",\r "title": "Get Customer Avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getCustomerAvatar",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/fields",\r "title": "Gets Website Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/interactions",\r "title": "Gets Website Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/logo",\r "title": "Get logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getLogo",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/offline_messages",\r "title": "Gets Website Offline Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getOfflineMessages",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/proactive_actions",\r "title": "Gets Website Proactive Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getProactiveActions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/snippet",\r "title": "Gets Website Snippet",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSnippet",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/system_avatar",\r "title": "Get System Avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSystemAvatar",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/notify",\r "title": "Notify new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "notify",\r "group": "Chat_Websites",\r "description": "<p>Motion 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>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/offline",\r "title": "Offline message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "offline",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "put",\r "url": "/api/chat/messages/{id}/reject",\r "title": "Rejects message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "put",\r "url": "/api/chat/websites/{id}",\r "title": "Update an existing Website",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/cloudProviders",\r "title": "Creates a new CloudProvider",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCloudProviders",\r "group": "CloudProviders",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"AmazonAWS\"",\r "\"Google\""\r ],\r "optional": false,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cloudProvider/index.js",\r "groupTitle": "CloudProviders"\r },\r {\r "type": "delete",\r "url": "/api/cloudProviders/{id}",\r "title": "Deletes a CloudProvider",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCloudProviders",\r "group": "CloudProviders",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cloudProvider/index.js",\r "groupTitle": "CloudProviders"\r },\r {\r "type": "get",\r "url": "/api/cloudProviders",\r "title": "Gets a list of CloudProviders",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCloudProviders",\r "group": "CloudProviders",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cloudProvider/index.js",\r "groupTitle": "CloudProviders"\r },\r {\r "type": "get",\r "url": "/api/cloudProviders/{id}",\r "title": "Gets a single CloudProvider",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCloudProviders",\r "group": "CloudProviders",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cloudProvider/index.js",\r "groupTitle": "CloudProviders"\r },\r {\r "type": "put",\r "url": "/api/cloudProviders/{id}",\r "title": "Update an existing CloudProvider",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateCloudProviders",\r "group": "CloudProviders",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cloudProvider/index.js",\r "groupTitle": "CloudProviders"\r },\r {\r "type": "post",\r "url": "/api/cm/companies",\r "title": "Creates a new Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCompanies",\r "group": "Cm_Companies",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "companyId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailDomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sStreet",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sPostalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sCity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sCountry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "delete",\r "url": "/api/cm/companies/{id}",\r "title": "Deletes a Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/describe",\r "title": "Gets table info about Companies",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies",\r "title": "Gets a list of Companies",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/{id}",\r "title": "Gets a single Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "post",\r "url": "/api/cm/companies/{id}/contacts",\r "title": "Creates new contacts",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addContacts",\r "group": "Cm_Companies",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "firstName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dateOfBirth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "facebook",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fb_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "twitter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "skype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "teams",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "viber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "line",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "wechat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "telegram",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "UserId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "scheduledat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "utcOffset",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/{id}/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getContacts",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "put",\r "url": "/api/cm/companies/{id}",\r "title": "Update an existing Company",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "delete",\r "url": "/api/cm/contacts/{id}",\r "title": "Deletes a Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteContacts",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/describe",\r "title": "Gets table info about Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeContacts",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts",\r "title": "Gets a list of Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetContacts",\r "group": "Cm_Contacts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}/finals",\r "title": "Gets contact hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}/hopper_histories",\r "title": "Gets contact hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}/hoppers",\r "title": "Gets contact hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts/create_many",\r "title": "Create Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "bulkCreate",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts",\r "title": "Create Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}/jscripty_sessions",\r "title": "Gets contact hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getJscriptySessions",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts/merge",\r "title": "Merge Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "merge",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}",\r "title": "Gets a single Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "show",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "put",\r "url": "/api/cm/contacts/{id}",\r "title": "Update a single Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "delete",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Deletes a Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "get",\r "url": "/api/cm/custom_fields",\r "title": "Gets a list of Custom Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "get",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Gets a single Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "put",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Update an existing Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper",\r "title": "Creates a new Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateHopper",\r "group": "Cm_Hopper",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "scheduledat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countbusyretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countcongestionretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countnoanswerretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "recallme",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ContactId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ListId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "UserId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "VoiceQueueId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "CampaignId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countnosuchnumberretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countdropretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countabandonedretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countmachineretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countagentrejectretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/describe",\r "title": "Gets table info about Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper",\r "title": "Gets a list of Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/{id}",\r "title": "Gets a single Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "delete",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Deletes a Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black/describe",\r "title": "Gets table info about Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black",\r "title": "Gets a list of Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Gets a single Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Update an existing Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/describe",\r "title": "Gets table info about HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final",\r "title": "Gets a list of HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/{id}",\r "title": "Gets a single HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper_final/checkContactHopper",\r "title": "Check if contact is in hopper",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "_checkContactHopper",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",\r "title": "Return number contacts for attributes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "countContactsIvrCampaignHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",\r "title": "Return number contacts for attributes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "countContactsQueueCampaignHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper_final/campaign/{id}",\r "title": "Move contacts in hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "moveContactsIvrCampaignHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper_final/voice/queue/{id}",\r "title": "Move contacts in hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "moveContactsQueueCampaignHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_final/{id}",\r "title": "Update a single hopper final",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper_history",\r "title": "Creates a new HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateHopperHistory",\r "group": "Cm_Hopper_History",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "state",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "statedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "scheduledat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countbusyretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countcongestionretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countnoanswerretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countglobal",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "originatecalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "originatecalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "starttime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "responsetime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "answertime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "droptime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "endtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ringtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "talktime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "followuptime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dropreason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "campaign",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "campaigntype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "amd",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "recallme",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "editedat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "edited",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countnosuchnumberretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countdropretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countabandonedretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countmachineretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countagentrejectretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history/describe",\r "title": "Gets table info about HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history",\r "title": "Gets a list of HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history/{id}",\r "title": "Gets a single HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_history/{id}",\r "title": "Update a single hopper history",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "delete",\r "url": "/api/cm/hopper/{id}",\r "title": "Delete Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroy",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/opencontacts",\r "title": "Gets Open Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getOpenContacts",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper/preview",\r "title": "Gets Preview Dialer Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getPreview",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper/timezone",\r "title": "Gets a single TZ data",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/timezone -d '{\"timezone\": [1]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTimezone",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/timezones",\r "title": "Gets TZs list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTimezones",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper/{id}",\r "title": "Update an existing Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "post",\r "url": "/api/cm/lists",\r "title": "Creates a new List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateLists",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialPrefix",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}",\r "title": "Deletes a List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/describe",\r "title": "Gets table info about Lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/users",\r "title": "Gets agents from list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists",\r "title": "Gets a list of Lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}/users",\r "title": "Removes agents from a list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}/dispositions",\r "title": "Removes dispositions from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}",\r "title": "Gets a single List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/users",\r "title": "Adds agents to a list",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/contacts",\r "title": "Creates new contacts",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addContacts",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "firstName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dateOfBirth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "facebook",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fb_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "twitter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "skype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "teams",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "viber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "line",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "wechat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "telegram",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "UserId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "scheduledat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "utcOffset",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/fields",\r "title": "Creates a new custom field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addCustomField",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getContacts",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/fields",\r "title": "Gets Custom Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getCustomFields",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/dispositions",\r "title": "Gets list dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/contacts/csv",\r "title": "Gets CSV List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "grunt",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "put",\r "url": "/api/cm/lists/{id}",\r "title": "Update an existing List",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts/upload/:id",\r "title": "Import new contacts by csv",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "import",\r "group": "Cm_contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts/upload",\r "title": "Upload csv",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "upload",\r "group": "Cm_contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts/csv",\r "title": "Create new contacts by csv",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "uploadCsv",\r "group": "Cm_contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_contacts"\r },\r {\r "type": "delete",\r "url": "/api/conditions/{id}",\r "title": "Deletes a Condition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteConditions",\r "group": "Conditions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/condition/index.js",\r "groupTitle": "Conditions"\r },\r {\r "type": "put",\r "url": "/api/conditions/{id}",\r "title": "Update an existing Condition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateConditions",\r "group": "Conditions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/condition/index.js",\r "groupTitle": "Conditions"\r },\r {\r "type": "post",\r "url": "/api/cm/custom_field",\r "title": "Create a new custom field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCustomField",\r "group": "Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Custom_Fields"\r },\r {\r "type": "post",\r "url": "/api/dashboards/items",\r "title": "Create dasboard item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "delete",\r "url": "/api/dashboards/items/{id}",\r "title": "Deletes a Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "get",\r "url": "/api/dashboards/items/{id}",\r "title": "Gets a single Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "put",\r "url": "/api/dashboards/items/{id}",\r "title": "Update an existing item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "post",\r "url": "/api/dashboards/clone",\r "title": "Clone an existing Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CloneDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "post",\r "url": "/api/dashboards",\r "title": "Creates a new Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDashboards",\r "group": "Dashboards",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "delete",\r "url": "/api/dashboards/{id}",\r "title": "Deletes a Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards",\r "title": "Gets a list of Dashboards",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}",\r "title": "Gets a single Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "post",\r "url": "/api/dashboards/{id}/items",\r "title": "Creates new item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addItem",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}/items",\r "title": "Gets items",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getItems",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "put",\r "url": "/api/dashboards/{id}",\r "title": "Update an existing Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "post",\r "url": "/api/integrations/desk/accounts",\r "title": "Creates a new Desk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateDesk_Accounts",\r "group": "Desk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"basic\""\r ],\r "optional": true,\r "field": "authType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "consumerKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "consumerSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tokenSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"integrationTab\"",\r "\"newTab\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/desk/accounts/{id}",\r "title": "Deletes a Desk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDesk_Accounts",\r "group": "Desk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/accounts",\r "title": "Gets a list of Desk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDesk_Accounts",\r "group": "Desk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/accounts/{id}",\r "title": "Gets a single Desk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDesk_Accounts",\r "group": "Desk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/desk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Desk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Desk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Desk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/desk/accounts/{id}",\r "title": "Update an existing Desk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateDesk_Accounts",\r "group": "Desk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskAccount/index.js",\r "groupTitle": "Desk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/desk/configurations",\r "title": "Creates a new Desk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateDesk_Configurations",\r "group": "Desk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/desk/configurations/{id}",\r "title": "Deletes a Desk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDesk_Configurations",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/configurations",\r "title": "Gets a list of Desk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDesk_Configurations",\r "group": "Desk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/configurations/{id}",\r "title": "Gets a single Desk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDesk_Configurations",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/desk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/desk/configurations/{id}",\r "title": "Update an existing Desk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateDesk_Configurations",\r "group": "Desk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskConfiguration/index.js",\r "groupTitle": "Desk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/desk/fields",\r "title": "Creates a new Desk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateDesk_Fields",\r "group": "Desk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskField/index.js",\r "groupTitle": "Desk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/desk/fields/{id}",\r "title": "Deletes a Desk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDesk_Fields",\r "group": "Desk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskField/index.js",\r "groupTitle": "Desk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/fields",\r "title": "Gets a list of Desk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDesk_Fields",\r "group": "Desk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskField/index.js",\r "groupTitle": "Desk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/desk/fields/{id}",\r "title": "Gets a single Desk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDesk_Fields",\r "group": "Desk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskField/index.js",\r "groupTitle": "Desk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/desk/fields/{id}",\r "title": "Update an existing Desk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateDesk_Fields",\r "group": "Desk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDeskField/index.js",\r "groupTitle": "Desk_Fields"\r },\r {\r "type": "post",\r "url": "/api/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/disposition/index.js",\r "groupTitle": "Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/disposition/index.js",\r "groupTitle": "Dispositions"\r },\r {\r "type": "get",\r "url": "/api/dispositions",\r "title": "Gets a list of Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDispositions",\r "group": "Dispositions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/disposition/index.js",\r "groupTitle": "Dispositions"\r },\r {\r "type": "get",\r "url": "/api/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/disposition/index.js",\r "groupTitle": "Dispositions"\r },\r {\r "type": "put",\r "url": "/api/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/disposition/index.js",\r "groupTitle": "Dispositions"\r },\r {\r "type": "post",\r "url": "/api/integrations/dynamics365/accounts",\r "title": "Creates a new Dynamics365 Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateDynamics365_Accounts",\r "group": "Dynamics365_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tenantId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/dynamics365/accounts/{id}",\r "title": "Deletes a Dynamics365 Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDynamics365_Accounts",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/accounts",\r "title": "Gets a list of Dynamics365 Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDynamics365_Accounts",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/accounts/{id}",\r "title": "Gets a single Dynamics365 Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDynamics365_Accounts",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/dynamics365/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/dynamics365/accounts/{id}",\r "title": "Update an existing Dynamics365 Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateDynamics365_Accounts",\r "group": "Dynamics365_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Account/index.js",\r "groupTitle": "Dynamics365_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/dynamics365/configurations",\r "title": "Creates a new Dynamics365 Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateDynamics365_Configurations",\r "group": "Dynamics365_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"incident\"",\r "\"phonecall\""\r ],\r "optional": true,\r "field": "ticketType",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/dynamics365/configurations/{id}",\r "title": "Deletes a Dynamics365 Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDynamics365_Configurations",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/configurations",\r "title": "Gets a list of Dynamics365 Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDynamics365_Configurations",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/configurations/{id}",\r "title": "Gets a single Dynamics365 Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDynamics365_Configurations",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/dynamics365/configurations/{id}",\r "title": "Update an existing Dynamics365 Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateDynamics365_Configurations",\r "group": "Dynamics365_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Configuration/index.js",\r "groupTitle": "Dynamics365_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/dynamics365/fields",\r "title": "Creates a new Dynamics365 Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateDynamics365_Fields",\r "group": "Dynamics365_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Field/index.js",\r "groupTitle": "Dynamics365_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/dynamics365/fields/{id}",\r "title": "Deletes a Dynamics365 Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDynamics365_Fields",\r "group": "Dynamics365_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Field/index.js",\r "groupTitle": "Dynamics365_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/fields",\r "title": "Gets a list of Dynamics365 Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDynamics365_Fields",\r "group": "Dynamics365_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Field/index.js",\r "groupTitle": "Dynamics365_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/dynamics365/fields/{id}",\r "title": "Gets a single Dynamics365 Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDynamics365_Fields",\r "group": "Dynamics365_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Field/index.js",\r "groupTitle": "Dynamics365_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/dynamics365/fields/{id}",\r "title": "Update an existing Dynamics365 Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateDynamics365_Fields",\r "group": "Dynamics365_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intDynamics365Field/index.js",\r "groupTitle": "Dynamics365_Fields"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/users",\r "title": "Add agents to a fax account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ecm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "headerinfo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"2400\"",\r "\"4800\"",\r "\"7200\"",\r "\"9600\"",\r "\"12000\"",\r "\"14400\""\r ],\r "optional": true,\r "field": "minrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"2400\"",\r "\"4800\"",\r "\"7200\"",\r "\"9600\"",\r "\"12000\"",\r "\"14400\""\r ],\r "optional": true,\r "field": "maxrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "modem",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "gateway",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "faxdetect",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "t38timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SIP\"",\r "\"IAX\"",\r "\"DADHI\"",\r "\"KHOMP\""\r ],\r "optional": true,\r "field": "tech",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notificationTemplate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationSound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationShake",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "waitForTheAssignedAgent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "queueTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queueTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "agentTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mandatoryDispositionPauseId",\r "description": "<p>Status to put when mandatory disposition is enabled</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mandatoryDisposition",\r "description": "<p>Enabled/disables mandatory dispo on a queue</p>"\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/describe",\r "title": "Gets table info about Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/users",\r "title": "Gets agents from fax account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/accounts/{id}/users",\r "title": "Removes agents from a fax account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/accounts/{id}/canned_answers",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAnswers",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Removes dispositions from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/canned_answers",\r "title": "Creates new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnswer",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/addaccountapplications",\r "title": "Creates new account and applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "firstMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/canned_answers",\r "title": "Gets account canned answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/applications",\r "title": "Gets account pplications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/messages",\r "title": "Gets account messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/send",\r "title": "Send new fax",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendFax",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "put",\r "url": "/api/fax/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/updateaccountapplications",\r "title": "Update account and applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/applications",\r "title": "Creates a new Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateApplications",\r "group": "Fax_Applications",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "delete",\r "url": "/api/fax/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "get",\r "url": "/api/fax/applications",\r "title": "Gets a list of Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "get",\r "url": "/api/fax/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "put",\r "url": "/api/fax/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions/{id}/tags",\r "title": "Add tags to the interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTags",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Fax_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "firstMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/fax/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/fax/interactions/{id}/tags",\r "title": "Removes tags from interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTags",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Fax_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "failMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}/download",\r "title": "Get interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "put",\r "url": "/api/fax/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/{id}/download",\r "title": "Get message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Fax_Message",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Message"\r },\r {\r "type": "delete",\r "url": "/api/fax/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "put",\r "url": "/api/fax/messages/{id}/accept",\r "title": "Accepts message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "acceptMessage",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "put",\r "url": "/api/fax/messages/{id}/reject",\r "title": "Rejects message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "post",\r "url": "/api/fax/messages",\r "title": "Create message and send Fax",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "put",\r "url": "/api/fax/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "post",\r "url": "/api/fax/reports/queue",\r "title": "Creates a new Fax Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFax_Queue_Reports",\r "group": "Fax_Queue_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueueReport/index.js",\r "groupTitle": "Fax_Queue_Reports"\r },\r {\r "type": "delete",\r "url": "/api/fax/reports/queue/{id}",\r "title": "Deletes a Fax Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFax_Queue_Reports",\r "group": "Fax_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueueReport/index.js",\r "groupTitle": "Fax_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/queue/describe",\r "title": "Gets table info about Fax Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeFax_Queue_Reports",\r "group": "Fax_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueueReport/index.js",\r "groupTitle": "Fax_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/queue",\r "title": "Gets a list of Fax Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFax_Queue_Reports",\r "group": "Fax_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueueReport/index.js",\r "groupTitle": "Fax_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/queue/{id}",\r "title": "Gets a single Fax Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFax_Queue_Reports",\r "group": "Fax_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueueReport/index.js",\r "groupTitle": "Fax_Queue_Reports"\r },\r {\r "type": "put",\r "url": "/api/fax/reports/queue/{id}",\r "title": "Update an existing Fax Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFax_Queue_Reports",\r "group": "Fax_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueueReport/index.js",\r "groupTitle": "Fax_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/fax/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Fax_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": false,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/describe",\r "title": "Gets table info about Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/members",\r "title": "GetMembers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "put",\r "url": "/api/fax/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/reports/transfer",\r "title": "Creates a new Fax Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFax_Transfer_Reports",\r "group": "Fax_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"account\"",\r "\"agent\"",\r "\"queue\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "transferredAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxTransferReport/index.js",\r "groupTitle": "Fax_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/fax/reports/transfer/{id}",\r "title": "Deletes a Fax Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFax_Transfer_Reports",\r "group": "Fax_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxTransferReport/index.js",\r "groupTitle": "Fax_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/transfer/describe",\r "title": "Gets table info about Fax Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeFax_Transfer_Reports",\r "group": "Fax_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxTransferReport/index.js",\r "groupTitle": "Fax_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/transfer",\r "title": "Gets a list of Fax Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFax_Transfer_Reports",\r "group": "Fax_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxTransferReport/index.js",\r "groupTitle": "Fax_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/transfer/{id}",\r "title": "Gets a single Fax Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFax_Transfer_Reports",\r "group": "Fax_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxTransferReport/index.js",\r "groupTitle": "Fax_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/fax/reports/transfer/{id}",\r "title": "Update an existing Fax Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFax_Transfer_Reports",\r "group": "Fax_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxTransferReport/index.js",\r "groupTitle": "Fax_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/accounts",\r "title": "Creates a new Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "apiKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Deletes a Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts",\r "title": "Gets a list of Freshdesk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Gets a single Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Update an existing Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/configurations",\r "title": "Creates a new Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Deletes a Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations",\r "title": "Gets a list of Freshdesk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Gets a single Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Update an existing Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/fields",\r "title": "Creates a new Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Deletes a Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/fields",\r "title": "Gets a list of Freshdesk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Gets a single Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Update an existing Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshsales/accounts",\r "title": "Creates a new Freshsales Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshsales_Accounts",\r "group": "Freshsales_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "apiKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshsales/accounts/{id}",\r "title": "Deletes a Freshsales Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshsales_Accounts",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/accounts",\r "title": "Gets a list of Freshsales Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshsales_Accounts",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/accounts/{id}",\r "title": "Gets a single Freshsales Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshsales_Accounts",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshsales/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshsales/accounts/{id}",\r "title": "Update an existing Freshsales Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshsales_Accounts",\r "group": "Freshsales_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesAccount/index.js",\r "groupTitle": "Freshsales_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshsales/configurations",\r "title": "Creates a new Freshsales Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshsales_Configurations",\r "group": "Freshsales_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshsales/configurations/{id}",\r "title": "Deletes a Freshsales Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshsales_Configurations",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/configurations",\r "title": "Gets a list of Freshsales Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshsales_Configurations",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/configurations/{id}",\r "title": "Gets a single Freshsales Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshsales_Configurations",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshsales/configurations/{id}",\r "title": "Update an existing Freshsales Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshsales_Configurations",\r "group": "Freshsales_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesConfiguration/index.js",\r "groupTitle": "Freshsales_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshsales/fields",\r "title": "Creates a new Freshsales Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshsales_Fields",\r "group": "Freshsales_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesField/index.js",\r "groupTitle": "Freshsales_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshsales/fields/{id}",\r "title": "Deletes a Freshsales Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshsales_Fields",\r "group": "Freshsales_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesField/index.js",\r "groupTitle": "Freshsales_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/fields",\r "title": "Gets a list of Freshsales Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshsales_Fields",\r "group": "Freshsales_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesField/index.js",\r "groupTitle": "Freshsales_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshsales/fields/{id}",\r "title": "Gets a single Freshsales Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshsales_Fields",\r "group": "Freshsales_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesField/index.js",\r "groupTitle": "Freshsales_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshsales/fields/{id}",\r "title": "Update an existing Freshsales Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshsales_Fields",\r "group": "Freshsales_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshsalesField/index.js",\r "groupTitle": "Freshsales_Fields"\r },\r {\r "type": "post",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Add blacklists to an IVR campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns/{id}/lists",\r "title": "Add lists to an IVR campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddLists",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns/clone",\r "title": "Clone an existing IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CloneIVR_Campaigns",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns",\r "title": "Creates a new IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIVR_Campaigns",\r "group": "IVR_Campaigns",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ivr\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": "<p>Active/Disactive Campaign</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "limitCalls",\r "description": "<p>Max 200 calls.</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialOriginateTimeout",\r "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionMaxRetry",\r "description": "<p>#Congestion Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionRetryFrequency",\r "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyMaxRetry",\r "description": "<p>#Busy Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyRetryFrequency",\r "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerMaxRetry",\r "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerRetryFrequency",\r "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialGlobalMaxRetry",\r "description": "<p>#Global Max Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialGlobalInterval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"always\"",\r "\"never\"",\r "\"onlyIfOpen\""\r ],\r "optional": true,\r "field": "dialCheckDuplicateType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialAMDActive",\r "description": "<p>Active/Disactive AMD</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDInitialSilence",\r "description": "<p>#AMD Initial Silence</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDGreeting",\r "description": "<p>#AMD Greeting</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDAfterGreetingSilence",\r "description": "<p>#AMD After Greeting Silence</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDTotalAnalysisTime",\r "description": "<p>#AMD Total Analysis Time</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDMinWordLength",\r "description": "<p>#AMD Min Word Length</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDBetweenWordsSilence",\r "description": "<p>#AMD Between Words Silence</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDMaximumNumberOfWords",\r "description": "<p>#AMD Maximum Number Of Words</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDSilenceThreshold",\r "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDMaximumWordLength",\r "description": "<p>#AMD Maximum Word Length</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"DESC\"",\r "\"ASC\""\r ],\r "optional": true,\r "field": "dialOrderByScheduledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialPrefix",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialRandomLastDigitCallerIdNumber",\r "description": "<p>Random Last Digit (min:1, max:15)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCutDigit",\r "description": "<p>Cut Digit (min:1, max:15)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoSuchNumberMaxRetry",\r "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoSuchNumberRetryFrequency",\r "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialDropMaxRetry",\r "description": "<p>#Drop Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialDropRetryFrequency",\r "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAbandonedMaxRetry",\r "description": "<p>#Abandoned Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAbandonedRetryFrequency",\r "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialMachineMaxRetry",\r "description": "<p>#Machine Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialMachineRetryFrequency",\r "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAgentRejectMaxRetry",\r "description": "<p>#AgentReject Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAgentRejectRetryFrequency",\r "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}",\r "title": "Deletes a IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIVR_Campaigns",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Get IVR campaign blacklists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetBlackLists",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/finals",\r "title": "Gets IVR campaign hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/hopper_histories",\r "title": "Gets IVR campaign hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/hoppers",\r "title": "Gets IVR campaign hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns",\r "title": "Gets a list of IVR Campaigns",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIVR_Campaigns",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/lists",\r "title": "Get IVR campaign lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Remove blacklists from an IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}/lists",\r "title": "Remove lists from an IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveLists",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}",\r "title": "Gets a single IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIVR_Campaigns",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/blacks",\r "title": "Gets IVR campaign hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getHopperBlacks",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "put",\r "url": "/api/campaigns/{id}",\r "title": "Update an existing IVR Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateIVR_Campaigns",\r "group": "IVR_Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "IVR_Campaigns"\r },\r {\r "type": "post",\r "url": "/api/integrations/reports",\r "title": "Creates a new Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIntegration_Reports",\r "group": "Integration_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "integration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "eventChannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "ticketId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "integrationId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contacts",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interface",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentcalledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentconnectAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentcomplete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentcompleteAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "talktime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentacw",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "acwtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentringnoanswer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentringnoanswerAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentdump",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentdumpAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastevent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "destchannelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destchannelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destlanguage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destaccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destpriority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "projectId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "delete",\r "url": "/api/integrations/reports/{id}",\r "title": "Deletes a Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports/describe",\r "title": "Gets table info about Integration Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports",\r "title": "Gets a list of Integration Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports/{id}",\r "title": "Gets a single Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "put",\r "url": "/api/integrations/reports/{id}",\r "title": "Update an existing Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "post",\r "url": "/api/intervals",\r "title": "Creates a new Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIntervals",\r "group": "Intervals",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "delete",\r "url": "/api/intervals/{id}",\r "title": "Deletes a Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals",\r "title": "Gets a list of Intervals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIntervals",\r "group": "Intervals",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals/{id}",\r "title": "Gets a single Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/intervals/{id}/sub_intervals",\r "title": "Creates a new sub interval",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInterval",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/intervals/{id}/sub_intervals/create_many",\r "title": "Create new sub intervals set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals/{id}/sub_intervals",\r "title": "Get sub intervals set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "put",\r "url": "/api/intervals/{id}",\r "title": "Update an existing Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/jira",\r "title": "Creates a new issue",\r "examples": [\r {\r "title": "Example usage:",\r "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}",\r "type": "json"\r }\r ],\r "name": "Creates_Issue",\r "group": "Issue",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Bug\""\r ],\r "optional": true,\r "field": "issuetype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "summary",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jira/index.js",\r "groupTitle": "Issue"\r },\r {\r "type": "post",\r "url": "/api/jscripty/answers/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptyAnswerReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "answer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "projectname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "questionId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyAnswerReport/index.js",\r "groupTitle": "JscriptyAnswerReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/answers/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptyAnswerReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyAnswerReport/index.js",\r "groupTitle": "JscriptyAnswerReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/answers/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "JscriptyAnswerReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyAnswerReport/index.js",\r "groupTitle": "JscriptyAnswerReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/answers/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptyAnswerReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyAnswerReport/index.js",\r "groupTitle": "JscriptyAnswerReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/answers/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptyAnswerReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyAnswerReport/index.js",\r "groupTitle": "JscriptyAnswerReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/answers/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptyAnswerReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyAnswerReport/index.js",\r "groupTitle": "JscriptyAnswerReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/questions/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptyQuestionReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "answer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "projectname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "questionId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/sessions/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptySessionReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "starttime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "endtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "projectname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "completed",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports/{id}/questions",\r "title": "Gets Jscripty Session questions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getQuestions",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/projects/clone",\r "title": "Clone an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CloneProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "post",\r "url": "/api/jscripty/projects",\r "title": "Creates a new Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateProjects",\r "group": "Jscripty_Projects",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "formData",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enableUncompleteSave",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "sendUnpauseOnSubmit",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/projects/{id}",\r "title": "Deletes a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects",\r "title": "Gets a list of Projects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects/{id}",\r "title": "Gets a single Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects/{id}/answers",\r "title": "Gets jscripty project answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects/{id}/sessions",\r "title": "Gets jscripty project sessions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSessions",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects/{id}/summary",\r "title": "Gets jscripty project summary",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSummary",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "put",\r "url": "/api/jscripty/projects/{id}",\r "title": "Update an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/license",\r "title": "Gets License Info",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "index",\r "group": "License",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/license/index.js",\r "groupTitle": "License"\r },\r {\r "type": "put",\r "url": "/api/license/{id}",\r "title": "Update License Info",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "License",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/license/index.js",\r "groupTitle": "License"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/users",\r "title": "Add agents to a mail account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Creates a new IMAP server",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddImap",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "authentication",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "tls",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "connTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "authTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Creates a new SMTP server",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddSmtp",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pass",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secure",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "authentication",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}",\r "title": "Deletes a mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMailAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/describe",\r "title": "Gets table info about Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/users",\r "title": "Gets agents from mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Gets account IMAP server",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetImap",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Gets account SMTP server",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/users",\r "title": "Removes agents from a mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/canned_answers",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAnswers",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Removes dispositions from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Removes IMAP server from an account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveImmap",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Removes SMTP server from an account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/canned_answers",\r "title": "Creates new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnswer",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "attach",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "substatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "substatusAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "firstMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "lastMsgBody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "lastMsgText",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts",\r "title": "Create a mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/canned_answers",\r "title": "Gets account canned answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/messages",\r "title": "Gets account messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/send",\r "title": "Send new mail",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendMail",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "put",\r "url": "/api/mail/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/verify",\r "title": "Verify mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "verifySmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "get",\r "url": "/api/mail/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "put",\r "url": "/api/mail/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions/{id}/tags",\r "title": "Add tags to the interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTags",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Mail_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "attach",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "substatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "substatusAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "firstMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "lastMsgBody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "lastMsgText",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/mail/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/mail/interactions/{id}/tags",\r "title": "Removes tags from interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTags",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions/{id}/messages",\r "title": "Creates new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Mail_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "plainBody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "bcc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sentAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "attach",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "originTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "originCc",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}/download",\r "title": "Gets interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "put",\r "url": "/api/mail/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/mail/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "put",\r "url": "/api/mail/messages/{id}/accept",\r "title": "Accepts message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "acceptMessage",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "post",\r "url": "/api/mail/messages",\r "title": "Create a message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "createMessage",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/{id}/download",\r "title": "Gets message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "put",\r "url": "/api/mail/messages/{id}/reject",\r "title": "Rejects message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "put",\r "url": "/api/mail/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "post",\r "url": "/api/mail/reports/queue",\r "title": "Creates a new Mail Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateMail_Queue_Reports",\r "group": "Mail_Queue_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueueReport/index.js",\r "groupTitle": "Mail_Queue_Reports"\r },\r {\r "type": "delete",\r "url": "/api/mail/reports/queue/{id}",\r "title": "Deletes a Mail Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMail_Queue_Reports",\r "group": "Mail_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueueReport/index.js",\r "groupTitle": "Mail_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/queue/describe",\r "title": "Gets table info about Mail Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMail_Queue_Reports",\r "group": "Mail_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueueReport/index.js",\r "groupTitle": "Mail_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/queue",\r "title": "Gets a list of Mail Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMail_Queue_Reports",\r "group": "Mail_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueueReport/index.js",\r "groupTitle": "Mail_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/queue/{id}",\r "title": "Gets a single Mail Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMail_Queue_Reports",\r "group": "Mail_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueueReport/index.js",\r "groupTitle": "Mail_Queue_Reports"\r },\r {\r "type": "put",\r "url": "/api/mail/reports/queue/{id}",\r "title": "Update an existing Mail Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMail_Queue_Reports",\r "group": "Mail_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueueReport/index.js",\r "groupTitle": "Mail_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/mail/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Mail_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/describe",\r "title": "Gets table info about Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/members",\r "title": "GetMembers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "put",\r "url": "/api/mail/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/out_servers",\r "title": "Creates a new SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSMTPs",\r "group": "Mail_SMTP",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pass",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secure",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "authentication",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "delete",\r "url": "/api/mail/out_servers/{id}",\r "title": "Deletes a SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/out_servers",\r "title": "Gets a list of SMTPs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/out_servers/{id}",\r "title": "Gets a single SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "put",\r "url": "/api/mail/out_servers/{id}",\r "title": "Update an existing SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "post",\r "url": "/api/mail/substatuses",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSubstatuses",\r "group": "Mail_Substatuses",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSubstatus/index.js",\r "groupTitle": "Mail_Substatuses"\r },\r {\r "type": "delete",\r "url": "/api/mail/substatuses/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSubstatuses",\r "group": "Mail_Substatuses",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSubstatus/index.js",\r "groupTitle": "Mail_Substatuses"\r },\r {\r "type": "get",\r "url": "/api/mail/substatuses/describe",\r "title": "Gets table info about Substatuses",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSubstatuses",\r "group": "Mail_Substatuses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSubstatus/index.js",\r "groupTitle": "Mail_Substatuses"\r },\r {\r "type": "get",\r "url": "/api/mail/substatuses",\r "title": "Gets a list of Substatuses",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSubstatuses",\r "group": "Mail_Substatuses",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailSubstatus/index.js",\r "groupTitle": "Mail_Substatuses"\r },\r {\r "type": "get",\r "url": "/api/mail/substatuses/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSubstatuses",\r "group": "Mail_Substatuses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSubstatus/index.js",\r "groupTitle": "Mail_Substatuses"\r },\r {\r "type": "put",\r "url": "/api/mail/substatuses/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSubstatuses",\r "group": "Mail_Substatuses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSubstatus/index.js",\r "groupTitle": "Mail_Substatuses"\r },\r {\r "type": "post",\r "url": "/api/mail/reports/transfer",\r "title": "Creates a new Mail Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateMail_Transfer_Reports",\r "group": "Mail_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"account\"",\r "\"agent\"",\r "\"queue\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "transferredAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailTransferReport/index.js",\r "groupTitle": "Mail_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/mail/reports/transfer/{id}",\r "title": "Deletes a Mail Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMail_Transfer_Reports",\r "group": "Mail_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailTransferReport/index.js",\r "groupTitle": "Mail_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/transfer/describe",\r "title": "Gets table info about Mail Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMail_Transfer_Reports",\r "group": "Mail_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailTransferReport/index.js",\r "groupTitle": "Mail_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/transfer",\r "title": "Gets a list of Mail Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMail_Transfer_Reports",\r "group": "Mail_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailTransferReport/index.js",\r "groupTitle": "Mail_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/transfer/{id}",\r "title": "Gets a single Mail Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMail_Transfer_Reports",\r "group": "Mail_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailTransferReport/index.js",\r "groupTitle": "Mail_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/mail/reports/transfer/{id}",\r "title": "Update an existing Mail Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMail_Transfer_Reports",\r "group": "Mail_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailTransferReport/index.js",\r "groupTitle": "Mail_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports/describe",\r "title": "Gets table info about Member Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports",\r "title": "Gets a list of Member Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports/{id}",\r "title": "Gets a single Member Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/migrations",\r "title": "Gets a list of Migrations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMigrations",\r "group": "Migrations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/migration/index.js",\r "groupTitle": "Migrations"\r },\r {\r "type": "post",\r "url": "/api/voice/networks",\r "title": "Create a new network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "delete",\r "url": "/api/voice/networks/{id}",\r "title": "Deletes a network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "get",\r "url": "/api/networks",\r "title": "Gets a list of Networks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/networks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetNetworks",\r "group": "Networks",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "get",\r "url": "/api/networks/{id}",\r "title": "Gets a single Network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowNetworks",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "put",\r "url": "/api/voice/networks/{id}",\r "title": "Update an existing network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "post",\r "url": "/api/notifications",\r "title": "Send notification to user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Send",\r "group": "Notifications",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/notification/index.js",\r "groupTitle": "Notifications"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/users",\r "title": "Add agents to a openchannel account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "replyUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notificationTemplate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationSound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationShake",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "waitForTheAssignedAgent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mapKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "queueTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queueTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "agentTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mandatoryDispositionPauseId",\r "description": "<p>Status to put when mandatory disposition is enabled</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mandatoryDisposition",\r "description": "<p>Enabled/disables mandatory dispo on a queue</p>"\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/describe",\r "title": "Gets table info about Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/users",\r "title": "Gets agents from openchannel account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/accounts/{id}/users",\r "title": "Removes agents from a openchannel account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/accounts/{id}/canned_answers",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAnswers",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Removes dispositions from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/canned_answers",\r "title": "Creates new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnswer",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/canned_answers",\r "title": "Gets account canned answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/interactions",\r "title": "Gets Openchannel Account Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteractions",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/notify",\r "title": "Notify new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "notify",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/send",\r "title": "Send new openchannel message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendOpenchannel",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "put",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/applications",\r "title": "Creates a new Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateApplications",\r "group": "Openchannel_Applications",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "get",\r "url": "/api/openchannel/applications",\r "title": "Gets a list of Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "get",\r "url": "/api/openchannel/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "put",\r "url": "/api/openchannel/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions/{id}/tags",\r "title": "Add tags to the interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTags",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Openchannel_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "threadId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "externalUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/interactions/{id}/tags",\r "title": "Removes tags from interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTags",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Openchannel_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}/download",\r "title": "Gets interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "put",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Openchannel_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "put",\r "url": "/api/openchannel/messages/{id}/accept",\r "title": "Accepts message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "acceptMessage",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "put",\r "url": "/api/openchannel/messages/{id}/reject",\r "title": "Rejects message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "put",\r "url": "/api/openchannel/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "post",\r "url": "/api/openchannel/reports/queue",\r "title": "Creates a new Openchannel Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateOpenchannel_Queue_Reports",\r "group": "Openchannel_Queue_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueueReport/index.js",\r "groupTitle": "Openchannel_Queue_Reports"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/reports/queue/{id}",\r "title": "Deletes a Openchannel Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteOpenchannel_Queue_Reports",\r "group": "Openchannel_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueueReport/index.js",\r "groupTitle": "Openchannel_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/queue/describe",\r "title": "Gets table info about Openchannel Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeOpenchannel_Queue_Reports",\r "group": "Openchannel_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueueReport/index.js",\r "groupTitle": "Openchannel_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/queue",\r "title": "Gets a list of Openchannel Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetOpenchannel_Queue_Reports",\r "group": "Openchannel_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueueReport/index.js",\r "groupTitle": "Openchannel_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/queue/{id}",\r "title": "Gets a single Openchannel Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowOpenchannel_Queue_Reports",\r "group": "Openchannel_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueueReport/index.js",\r "groupTitle": "Openchannel_Queue_Reports"\r },\r {\r "type": "put",\r "url": "/api/openchannel/reports/queue/{id}",\r "title": "Update an existing Openchannel Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateOpenchannel_Queue_Reports",\r "group": "Openchannel_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueueReport/index.js",\r "groupTitle": "Openchannel_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Openchannel_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/describe",\r "title": "Gets table info about Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/members",\r "title": "GetMembers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "put",\r "url": "/api/openchannel/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/reports/transfer",\r "title": "Creates a new Openchannel Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateOpenchannel_Transfer_Reports",\r "group": "Openchannel_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"account\"",\r "\"agent\"",\r "\"queue\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "transferredAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelTransferReport/index.js",\r "groupTitle": "Openchannel_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/reports/transfer/{id}",\r "title": "Deletes a Openchannel Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteOpenchannel_Transfer_Reports",\r "group": "Openchannel_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelTransferReport/index.js",\r "groupTitle": "Openchannel_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/transfer/describe",\r "title": "Gets table info about Openchannel Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeOpenchannel_Transfer_Reports",\r "group": "Openchannel_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelTransferReport/index.js",\r "groupTitle": "Openchannel_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/transfer",\r "title": "Gets a list of Openchannel Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetOpenchannel_Transfer_Reports",\r "group": "Openchannel_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelTransferReport/index.js",\r "groupTitle": "Openchannel_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/transfer/{id}",\r "title": "Gets a single Openchannel Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowOpenchannel_Transfer_Reports",\r "group": "Openchannel_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelTransferReport/index.js",\r "groupTitle": "Openchannel_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/openchannel/reports/transfer/{id}",\r "title": "Update an existing Openchannel Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateOpenchannel_Transfer_Reports",\r "group": "Openchannel_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelTransferReport/index.js",\r "groupTitle": "Openchannel_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/pauses",\r "title": "Creates a new Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreatePauses",\r "group": "Pauses",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "delete",\r "url": "/api/pauses/{id}",\r "title": "Deletes a Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeletePauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pauses",\r "title": "Gets a list of Pauses",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPauses",\r "group": "Pauses",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pauses/{id}",\r "title": "Gets a single Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowPauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "put",\r "url": "/api/pauses/{id}",\r "title": "Update an existing Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updatePauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/plugins",\r "title": "Gets a list of Plugins",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPlugins",\r "group": "Plugins",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "get",\r "url": "/api/plugins/{id}",\r "title": "Gets a single Plugin",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowPlugins",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "delete",\r "url": "/api/plugins/{id}",\r "title": "Delete a plugin",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroyPlugin",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "get",\r "url": "/api/plugins/{id}/download",\r "title": "Download plugin source code",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "put",\r "url": "/api/plugins/{id}",\r "title": "Update an existing plugin",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updatePlugin",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "post",\r "url": "/api/plugins",\r "title": "Upload new plugin",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "uploadPlugin",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "get",\r "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",\r "title": "Redirect a plugin request to the specified path",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "webhookPlugin",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "post",\r "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",\r "title": "Redirect a plugin request to the specified path",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",\r "type": "json"\r }\r ],\r "name": "webhookPlugin",\r "group": "Plugins",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/plugin/index.js",\r "groupTitle": "Plugins"\r },\r {\r "type": "delete",\r "url": "/api/pm2/{id}",\r "title": "Deletes an existing process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeletePm2Process",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/pm2/{id}",\r "title": "Gets a single pm2 process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPm2Process",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/pm2",\r "title": "Gets pm2 processes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPm2Processes",\r "group": "Pm2",\r "description": "<p>Motion returns the pm2 processes list.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "post",\r "url": "/api/pm2",\r "title": "Start a single pm2 process",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "StartPm2Process",\r "group": "Pm2",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "script",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "put",\r "url": "/api/pm2/{id}",\r "title": "Update an existing process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "UpdatePm2Process",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/rpc/campaigns/",\r "title": "Gets a list of campaigns",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Campaigns",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/fax/accounts",\r "title": "Gets a list of FaxAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "FaxAccounts",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "put",\r "url": "/api/rpc/agents/:id/capacity",\r "title": "Sets agent capacity",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTAgentCapacity",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/agents",\r "title": "Gets a list of RTAgents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTAgents",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/chat/queues",\r "title": "Gets a list of RTChatQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTChatQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/fax/queues",\r "title": "Gets a list of RTFaxQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTFaxQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/mail/accounts",\r "title": "Gets a list of RTMailAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTMailAccounts",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/mail/queues",\r "title": "Gets a list of RTMailQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTMailQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/openchannel/queues",\r "title": "Gets a list of RTOpenchannelQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTOpenchannelQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/outbound/channels",\r "title": "Gets a list of RTOutboundChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTOutboundChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/sms/queues",\r "title": "Gets a list of RTSmsQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTSmsQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/telephones",\r "title": "Gets a list of RTTelephones",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTTelephones",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/trunks",\r "title": "Gets a list of RTTrunks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTTrunks",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/channels",\r "title": "Gets a list of RTVoiceChannelMixMonitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceChannelMixMonitor",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/channels",\r "title": "Gets a list of RTVoiceChannelStopMixMonitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceChannelStopMixMonitor",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/channels",\r "title": "Gets a list of RTVoiceChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}",\r "title": "Gets a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannel",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",\r "title": "Hangup a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannelHangup",\r "group": "RPC_Realtime",\r "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",\r "title": "Hangup a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannelRedirect",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/preview/{id}",\r "title": "Gets a single preview contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueuePreview",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/outbound",\r "title": "Gets a list of RTOutbound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues",\r "title": "Gets a list of RTVoiceQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels",\r "title": "Gets a list of RTVoiceQueuesChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueuesChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/chat/queues/{id}",\r "title": "Gets a single RTChatQueue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRTChatQueues",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/fax/queues/{id}",\r "title": "Gets a single RTFaxQueue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRTFaxQueues",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/mail/queues/{id}",\r "title": "Gets a single RTMailQueue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRTMailQueues",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/openchannel/queues/{id}",\r "title": "Gets a single RTOpenchannelQueue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRTOpenchannelQueues",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/sms/queues/{id}",\r "title": "Gets a single RTSmsQueue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRTSmsQueues",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/{id}",\r "title": "Gets a single RTVoiceQueue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRTVoiceQueues",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/rpc/agents/:id/notify",\r "title": "Notify message to a specific agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "agentNotify",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/rpc/chat/queues/:id/notify",\r "title": "Notify message to a specific queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "chatQueueNotify",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/chat/queues/waitinginteractions",\r "title": "Gets a list of chatQueuesWaitingInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "chatQueuesWaitingInteractions",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/rpc/fax/queues/:id/notify",\r "title": "Notify message to a specific queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "faxQueueNotify",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/fax/queues/waitinginteractions",\r "title": "Gets a list of faxQueuesWaitingInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "faxQueuesWaitingInteractions",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/rpc/mail/queues/:id/notify",\r "title": "Notify message to a specific queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "mailQueueNotify",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/mail/queues/waitinginteractions",\r "title": "Gets a list of mailQueuesWaitingInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "mailQueuesWaitingInteractions",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/rpc/openchannel/queues/:id/notify",\r "title": "Notify message to a specific queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "openchannelQueueNotify",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/openchannel/queues/waitinginteractions",\r "title": "Gets a list of openchannelQueuesWaitingInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "openchannelQueuesWaitingInteractions",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/rpc/sms/queues/:id/notify",\r "title": "Notify message to a specific queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "smsQueueNotify",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/sms/queues/waitinginteractions",\r "title": "Gets a list of smsQueuesWaitingInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "smsQueuesWaitingInteractions",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/accounts",\r "title": "Creates a new Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "securityToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"integrationTab\"",\r "\"newTab\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Deletes a Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts",\r "title": "Gets a list of Salesforce Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Gets a single Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Update an existing Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/configurations",\r "title": "Creates a new Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Task\"",\r "\"Case\""\r ],\r "optional": true,\r "field": "ticketType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"contact_lead\"",\r "\"contact\"",\r "\"lead\""\r ],\r "optional": true,\r "field": "moduleSearch",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"nothing\"",\r "\"contact\"",\r "\"lead\""\r ],\r "optional": true,\r "field": "moduleCreate",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Deletes a Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations",\r "title": "Gets a list of Salesforce Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Gets a single Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Update an existing Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/fields",\r "title": "Creates a new Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Fields",\r "group": "Salesforce_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Deletes a Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/fields",\r "title": "Gets a list of Salesforce Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Gets a single Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Update an existing Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "post",\r "url": "/api/schedules",\r "title": "Creates a new Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSchedules",\r "group": "Schedules",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": false,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "cron",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "startAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "endAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "subtractNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"years\"",\r "\"quarters\"",\r "\"months\"",\r "\"weeks\"",\r "\"days\"",\r "\"hours\"",\r "\"minutes\""\r ],\r "optional": false,\r "field": "subtractUnit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"csv\"",\r "\"pdf\"",\r "\"xlsx\""\r ],\r "optional": false,\r "field": "output",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"custom\"",\r "\"default\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "sendMail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "bcc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "sendIfEmpty",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "delete",\r "url": "/api/schedules/{id}",\r "title": "Deletes a Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules",\r "title": "Gets a list of Schedules",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSchedules",\r "group": "Schedules",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules/{id}",\r "title": "Gets a single Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules/{id}/run",\r "title": "Run Scheduler",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "put",\r "url": "/api/schedules/{id}",\r "title": "Update an existing Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "post",\r "url": "/api/screen/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Screen_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interactionid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "startedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "createdAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "updatedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "get",\r "url": "/api/screen/recordings/describe",\r "title": "Gets table info about Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeRecordings",\r "group": "Screen_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "get",\r "url": "/api/screen/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Screen_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "get",\r "url": "/api/screen/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Screen_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/screen/recordings/{id}",\r "title": "Delete screen recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroy",\r "group": "Screen_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "get",\r "url": "/api/screen/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Screen_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "put",\r "url": "/api/screen/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Screen_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/screenRecording/index.js",\r "groupTitle": "Screen_Recordings"\r },\r {\r "type": "post",\r "url": "/api/integrations/servicenow/accounts",\r "title": "Creates a new Servicenow Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateServicenow_Accounts",\r "group": "Servicenow_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/servicenow/accounts/{id}",\r "title": "Deletes a Servicenow Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteServicenow_Accounts",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/accounts",\r "title": "Gets a list of Servicenow Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetServicenow_Accounts",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/accounts/{id}",\r "title": "Gets a single Servicenow Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowServicenow_Accounts",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/servicenow/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/servicenow/accounts/{id}",\r "title": "Update an existing Servicenow Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateServicenow_Accounts",\r "group": "Servicenow_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowAccount/index.js",\r "groupTitle": "Servicenow_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/servicenow/configurations",\r "title": "Creates a new Servicenow Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateServicenow_Configurations",\r "group": "Servicenow_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/servicenow/configurations/{id}",\r "title": "Deletes a Servicenow Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteServicenow_Configurations",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/configurations",\r "title": "Gets a list of Servicenow Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetServicenow_Configurations",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/configurations/{id}",\r "title": "Gets a single Servicenow Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowServicenow_Configurations",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/servicenow/configurations/{id}",\r "title": "Update an existing Servicenow Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateServicenow_Configurations",\r "group": "Servicenow_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowConfiguration/index.js",\r "groupTitle": "Servicenow_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/servicenow/fields",\r "title": "Creates a new Servicenow Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateServicenow_Fields",\r "group": "Servicenow_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowField/index.js",\r "groupTitle": "Servicenow_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/servicenow/fields/{id}",\r "title": "Deletes a Servicenow Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteServicenow_Fields",\r "group": "Servicenow_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowField/index.js",\r "groupTitle": "Servicenow_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/fields",\r "title": "Gets a list of Servicenow Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetServicenow_Fields",\r "group": "Servicenow_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowField/index.js",\r "groupTitle": "Servicenow_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/servicenow/fields/{id}",\r "title": "Gets a single Servicenow Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowServicenow_Fields",\r "group": "Servicenow_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowField/index.js",\r "groupTitle": "Servicenow_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/servicenow/fields/{id}",\r "title": "Update an existing Servicenow Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateServicenow_Fields",\r "group": "Servicenow_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intServicenowField/index.js",\r "groupTitle": "Servicenow_Fields"\r },\r {\r "type": "get",\r "url": "/api/settings",\r "title": "Gets a list of Settings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSettings",\r "group": "Settings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}",\r "title": "Gets a single Setting",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSettings",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/favicon",\r "title": "Add Favicon",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addFavicon",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/logo",\r "title": "Add logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogo",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/logo_login",\r "title": "Add logo login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogoLogin",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/preferred",\r "title": "Add Preferred",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addPreferred",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/favicon",\r "title": "Get Favicon",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",\r "type": "json"\r }\r ],\r "name": "getFavicon",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/gdpr",\r "title": "Get gdpr settings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getGdpr",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/logo",\r "title": "Get logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",\r "type": "json"\r }\r ],\r "name": "getLogo",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/logo_login",\r "title": "Get logo login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",\r "type": "json"\r }\r ],\r "name": "getLogoLogin",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/preferred",\r "title": "Get Preferred",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",\r "type": "json"\r }\r ],\r "name": "getPreferred",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "put",\r "url": "/api/settings/{id}",\r "title": "Update an existing Setting",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSettings",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/users",\r "title": "Add agents to a sms account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"twilio\"",\r "\"skebby\"",\r "\"connectel\"",\r "\"clicksend\"",\r "\"plivo\"",\r "\"clickatell\"",\r "\"csc\"",\r "\"infobip\"",\r "\"intelepeer\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountSid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "authId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "authToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SI\"",\r "\"TI\"",\r "\"GP\""\r ],\r "optional": true,\r "field": "smsMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "apiKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "senderString",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "deliveryReport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notificationTemplate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationSound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationShake",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "waitForTheAssignedAgent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "queueTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queueTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "agentTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "baseUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mandatoryDispositionPauseId",\r "description": "<p>Status to put when mandatory disposition is enabled</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mandatoryDisposition",\r "description": "<p>Enabled/disables mandatory dispo on a queue</p>"\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/describe",\r "title": "Gets table info about Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/users",\r "title": "Gets agents from sms account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/accounts/{id}/users",\r "title": "Removes agents from a sms account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/accounts/{id}/canned_answers",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAnswers",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Removes dispositions from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "put",\r "url": "/api/sms/messages/{id}/accept",\r "title": "Accepts message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "acceptMessage",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/canned_answers",\r "title": "Creates new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnswer",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/canned_answers",\r "title": "Gets account canned answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/interactions",\r "title": "Gets Sms Account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteractions",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/notify",\r "title": "Notify new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "notify",\r "group": "Sms_Accounts",\r "description": "<p>Motion 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>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "put",\r "url": "/api/sms/messages/{id}/reject",\r "title": "Rejects message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/send",\r "title": "Send new sms message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendSms",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/messages/{id}/status",\r "title": "Receive message status",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",\r "type": "json"\r }\r ],\r "name": "statusMessage",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/status",\r "title": "Receive message status",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",\r "type": "json"\r }\r ],\r "name": "statusMessage",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/status",\r "title": "Receive message status as get request",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",\r "type": "json"\r }\r ],\r "name": "statusMessage",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "put",\r "url": "/api/sms/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/applications",\r "title": "Creates a new Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateApplications",\r "group": "Sms_Applications",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "delete",\r "url": "/api/sms/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "get",\r "url": "/api/sms/applications",\r "title": "Gets a list of Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "get",\r "url": "/api/sms/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "put",\r "url": "/api/sms/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions/{id}/tags",\r "title": "Add tags to the interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTags",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Sms_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "firstMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/sms/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/sms/interactions/{id}/tags",\r "title": "Removes tags from interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTags",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Sms_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}/download",\r "title": "Gets interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "put",\r "url": "/api/sms/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Sms_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "delete",\r "url": "/api/sms/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "put",\r "url": "/api/sms/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "post",\r "url": "/api/sms/reports/queue",\r "title": "Creates a new Sms Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSms_Queue_Reports",\r "group": "Sms_Queue_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueueReport/index.js",\r "groupTitle": "Sms_Queue_Reports"\r },\r {\r "type": "delete",\r "url": "/api/sms/reports/queue/{id}",\r "title": "Deletes a Sms Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSms_Queue_Reports",\r "group": "Sms_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueueReport/index.js",\r "groupTitle": "Sms_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/queue/describe",\r "title": "Gets table info about Sms Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSms_Queue_Reports",\r "group": "Sms_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueueReport/index.js",\r "groupTitle": "Sms_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/queue",\r "title": "Gets a list of Sms Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSms_Queue_Reports",\r "group": "Sms_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueueReport/index.js",\r "groupTitle": "Sms_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/queue/{id}",\r "title": "Gets a single Sms Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSms_Queue_Reports",\r "group": "Sms_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueueReport/index.js",\r "groupTitle": "Sms_Queue_Reports"\r },\r {\r "type": "put",\r "url": "/api/sms/reports/queue/{id}",\r "title": "Update an existing Sms Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSms_Queue_Reports",\r "group": "Sms_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueueReport/index.js",\r "groupTitle": "Sms_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/sms/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Sms_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/describe",\r "title": "Gets table info about Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/members",\r "title": "GetMembers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "put",\r "url": "/api/sms/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/reports/transfer",\r "title": "Creates a new Sms Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSms_Transfer_Reports",\r "group": "Sms_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"account\"",\r "\"agent\"",\r "\"queue\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "transferredAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsTransferReport/index.js",\r "groupTitle": "Sms_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/sms/reports/transfer/{id}",\r "title": "Deletes a Sms Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSms_Transfer_Reports",\r "group": "Sms_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsTransferReport/index.js",\r "groupTitle": "Sms_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/transfer/describe",\r "title": "Gets table info about Sms Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSms_Transfer_Reports",\r "group": "Sms_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsTransferReport/index.js",\r "groupTitle": "Sms_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/transfer",\r "title": "Gets a list of Sms Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSms_Transfer_Reports",\r "group": "Sms_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsTransferReport/index.js",\r "groupTitle": "Sms_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/transfer/{id}",\r "title": "Gets a single Sms Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSms_Transfer_Reports",\r "group": "Sms_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsTransferReport/index.js",\r "groupTitle": "Sms_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/sms/reports/transfer/{id}",\r "title": "Update an existing Sms Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSms_Transfer_Reports",\r "group": "Sms_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsTransferReport/index.js",\r "groupTitle": "Sms_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/sounds",\r "title": "Gets a list of Sounds",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSounds",\r "group": "Sounds",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "get",\r "url": "/api/sounds/{id}",\r "title": "Gets a single Sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSounds",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "post",\r "url": "/api/sounds",\r "title": "Create a new sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addSound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "delete",\r "url": "/api/sounds/{id}",\r "title": "Deletes a sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroySound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "get",\r "url": "/api/sounds/{id}/download",\r "title": "Download Sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "put",\r "url": "/api/sounds",\r "title": "Update an existing new sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "post",\r "url": "/api/square/details/reports",\r "title": "Creates a new Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "node",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "project_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "delete",\r "url": "/api/square/details/reports/{id}",\r "title": "Deletes a Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports/describe",\r "title": "Gets table info about Square Detail Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports",\r "title": "Gets a list of Square Detail Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports/{id}",\r "title": "Gets a single Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "put",\r "url": "/api/square/details/reports/{id}",\r "title": "Update an existing Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "post",\r "url": "/api/square/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Square_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareMessage/index.js",\r "groupTitle": "Square_Messages"\r },\r {\r "type": "delete",\r "url": "/api/square/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Square_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareMessage/index.js",\r "groupTitle": "Square_Messages"\r },\r {\r "type": "get",\r "url": "/api/square/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Square_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareMessage/index.js",\r "groupTitle": "Square_Messages"\r },\r {\r "type": "get",\r "url": "/api/square/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Square_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareMessage/index.js",\r "groupTitle": "Square_Messages"\r },\r {\r "type": "put",\r "url": "/api/square/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Square_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareMessage/index.js",\r "groupTitle": "Square_Messages"\r },\r {\r "type": "post",\r "url": "/api/square/odbc",\r "title": "Creates a new ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateODBCs",\r "group": "Square_ODBC",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dsn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "delete",\r "url": "/api/square/odbc/{id}",\r "title": "Deletes a ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc",\r "title": "Gets a list of ODBCs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc/{id}",\r "title": "Gets a single ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc/{id}/test",\r "title": "Test Odbc",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "test",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "put",\r "url": "/api/square/odbc/{id}",\r "title": "Update an existing ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "post",\r "url": "/api/square/projects",\r "title": "Creates a new Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateProjects",\r "group": "Square_Projects",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notes",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "preproduction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "production",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "delete",\r "url": "/api/square/projects/{id}",\r "title": "Deletes a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects",\r "title": "Gets a list of Projects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects/{id}",\r "title": "Gets a single Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "post",\r "url": "/api/square/projects/{id}/users",\r "title": "Adds user permissions to a Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addUsers",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects/{id}/users",\r "title": "Gets users permissions from Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getUsers",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "delete",\r "url": "/api/square/projects/{id}/users",\r "title": "Removes user permissions from a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "removeUsers",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "put",\r "url": "/api/square/projects/{id}",\r "title": "Update an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "post",\r "url": "/api/square/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Square_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dnid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "projectName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "saveName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "savePath",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "format",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/square/recordings/{id}/delete",\r "title": "Delete recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroy",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "put",\r "url": "/api/square/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "post",\r "url": "/api/square/reports",\r "title": "Creates a new Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSquare_Reports",\r "group": "Square_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "network",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "network_script",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "request",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "version",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingani2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callington",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingtns",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dnid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rdnis",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enhanced",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "threadid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "project_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "bot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "delete",\r "url": "/api/square/reports/{id}",\r "title": "Deletes a Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports/describe",\r "title": "Gets table info about Square Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports",\r "title": "Gets a list of Square Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports/{id}",\r "title": "Gets a single Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "put",\r "url": "/api/square/reports/{id}",\r "title": "Update an existing Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/configurations",\r "title": "Creates a new SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Deletes a SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations",\r "title": "Gets a list of SugarCRM Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Gets a single SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Update an existing SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/accounts",\r "title": "Creates a new Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Deletes a Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts",\r "title": "Gets a list of Sugarcrm Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Gets a single Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Update an existing Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/fields",\r "title": "Creates a new Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Deletes a Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/fields",\r "title": "Gets a list of Sugarcrm Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Gets a single Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Update an existing Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/system",\r "title": "Gets system information",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/system -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSystemInformation",\r "group": "System_Information",\r "description": "<p>Motion returns the system information.</p>",\r "version": "0.0.0",\r "filename": "server/api/system/index.js",\r "groupTitle": "System_Information"\r },\r {\r "type": "get",\r "url": "/api/system/process",\r "title": "Gets system information",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/system -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSystemInformation",\r "group": "System_Information",\r "description": "<p>Motion returns the system information.</p>",\r "version": "0.0.0",\r "filename": "server/api/system/index.js",\r "groupTitle": "System_Information"\r },\r {\r "type": "post",\r "url": "/api/tags",\r "title": "Creates a new Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTags",\r "group": "Tags",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "delete",\r "url": "/api/tags/{id}",\r "title": "Deletes a Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "get",\r "url": "/api/tags",\r "title": "Gets a list of Tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTags",\r "group": "Tags",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "get",\r "url": "/api/tags/{id}",\r "title": "Gets a single Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "put",\r "url": "/api/tags/{id}",\r "title": "Update an existing Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "post",\r "url": "/api/teams/{id}/queues",\r "title": "Add queues to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/teams",\r "title": "Creates a new Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTeams",\r "group": "Teams",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}",\r "title": "Deletes a Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}/users",\r "title": "Gets agents from team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}/queues?channel={channel}",\r "title": "Gets Queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams",\r "title": "Gets a list of Teams",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Teams",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}/users",\r "title": "Removes agents from a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}/queues",\r "title": "Remove queues to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}",\r "title": "Gets a single Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/teams/{id}/users",\r "title": "Adds agents to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "put",\r "url": "/api/teams/{id}",\r "title": "Update an existing Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/templates",\r "title": "Creates a new Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTemplates",\r "group": "Templates",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "html",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "delete",\r "url": "/api/templates/{id}",\r "title": "Deletes a Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "get",\r "url": "/api/templates",\r "title": "Gets a list of Templates",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTemplates",\r "group": "Templates",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "get",\r "url": "/api/templates/{id}",\r "title": "Gets a single Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "put",\r "url": "/api/templates/{id}",\r "title": "Update an existing Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "post",\r "url": "/api/triggers",\r "title": "Creates a new Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTriggers",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "status",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "delete",\r "url": "/api/triggers/{id}",\r "title": "Deletes a Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers",\r "title": "Gets a list of Triggers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTriggers",\r "group": "Triggers",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}",\r "title": "Gets a single Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/actions",\r "title": "Creates new actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAction",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "action",\r "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "data7",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/all_conditions",\r "title": "Creates a new \"AND\"condition",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAllCondition",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/any_conditions",\r "title": "Creates a new \"OR\"condition",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnyCondition",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/actions",\r "title": "Gets Trigger Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getActions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/all_conditions",\r "title": "Gets \"AND\" Trigger Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAllConditions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/any_conditions",\r "title": "Gets \"OR\" Trigger Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnyConditions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "put",\r "url": "/api/triggers/{id}",\r "title": "Update an existing Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/trunks/clone",\r "title": "Clone an existing Trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CloneTrunks",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "post",\r "url": "/api/trunks",\r "title": "Create a new trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Trunks",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"friend\"",\r "\"user\"",\r "\"peer\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ALLOWED_NOT_SCREENED\"",\r "\"ALLOWED_PASSED_SCREEN\"",\r "\"ALLOWED_FAILED_SCREEN\"",\r "\"ALLOWED\"",\r "\"PROHIB_NOT_SCREENED\"",\r "\"PROHIB_PASSED_SCREEN\"",\r "\"PROHIB_FAILED_SCREEN\"",\r "\"PROHIB\""\r ],\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "permit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "md5secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotesecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transport",\r "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rfc2833\"",\r "\"info\"",\r "\"shortinfo\"",\r "\"inband\"",\r "\"auto\""\r ],\r "optional": true,\r "field": "dtmfmode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"outgoing\""\r ],\r "optional": true,\r "field": "directmedia",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "directrtpsetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediapermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediadeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nat",\r "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedcallgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedpickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tonezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disallow",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "allow",\r "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autoframing",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "insecure",\r "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trustrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trust_id_outbound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"never\""\r ],\r "optional": true,\r "field": "progressinband",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "promiscredir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "useclientcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "setvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "callcounter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "busylevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowoverlap",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowsubscribe",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowtransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ignoresdpversion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subscribecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "template",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"always\""\r ],\r "optional": true,\r "field": "videosupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxcallbitrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "rfc2833compensate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"accept\"",\r "\"refuse\"",\r "\"originate\""\r ],\r "optional": true,\r "field": "session_timers",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_expires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_minse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"uac\"",\r "\"uas\""\r ],\r "optional": true,\r "field": "session_refresher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "t38pt_usertpsource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromdomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "qualify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "keepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtptimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpholdtimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpkeepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"pai\""\r ],\r "optional": true,\r "field": "sendrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "outboundproxy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackextension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timert1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timerb",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "qualifyfreq",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactpermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactdeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactacl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "unsolicited_mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "use_q850_reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxforwards",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "encryption",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "avpf",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "force_avp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "icesupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "dtlsenable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"fingerprint\"",\r "\"certificate\""\r ],\r "optional": true,\r "field": "dtlsverify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dtlsrekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscertfile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsprivatekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscipher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscafile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscapath",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"active\"",\r "\"passive\"",\r "\"actpass\""\r ],\r "optional": true,\r "field": "dtlssetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsfingerprint",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "usereqphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordonfeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordofffeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "call_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "registertrying",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "subscribemwi",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vmexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohinterpret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohsuggest",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parkinglot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"update,nonat\""\r ],\r "optional": true,\r "field": "canreinvite",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "registry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "otherFields",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": false,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "t38pt_udptl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "delete",\r "url": "/api/trunks/{id}",\r "title": "Deletes a trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "get",\r "url": "/api/trunks",\r "title": "Gets a list of Trunks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTrunks",\r "group": "Trunks",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "get",\r "url": "/api/trunks/{id}",\r "title": "Gets a single Trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTrunks",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "put",\r "url": "/api/trunks/{id}",\r "title": "Update an existing trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "post",\r "url": "/api/userProfile/resources",\r "title": "Creates a new User Profile Resource",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateUser_Profile_Resources",\r "group": "User_Profile_Resources",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "resourceId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileResource/index.js",\r "groupTitle": "User_Profile_Resources"\r },\r {\r "type": "delete",\r "url": "/api/userProfile/resources/{id}",\r "title": "Deletes a User Profile Resource",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteUser_Profile_Resources",\r "group": "User_Profile_Resources",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileResource/index.js",\r "groupTitle": "User_Profile_Resources"\r },\r {\r "type": "get",\r "url": "/api/userProfile/resources/describe",\r "title": "Gets table info about User Profile Resources",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeUser_Profile_Resources",\r "group": "User_Profile_Resources",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileResource/index.js",\r "groupTitle": "User_Profile_Resources"\r },\r {\r "type": "get",\r "url": "/api/userProfile/resources",\r "title": "Gets a list of User Profile Resources",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetUser_Profile_Resources",\r "group": "User_Profile_Resources",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileResource/index.js",\r "groupTitle": "User_Profile_Resources"\r },\r {\r "type": "get",\r "url": "/api/userProfile/resources/{id}",\r "title": "Gets a single User Profile Resource",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowUser_Profile_Resources",\r "group": "User_Profile_Resources",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileResource/index.js",\r "groupTitle": "User_Profile_Resources"\r },\r {\r "type": "put",\r "url": "/api/userProfile/resources/{id}",\r "title": "Update an existing User Profile Resource",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateUser_Profile_Resources",\r "group": "User_Profile_Resources",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileResource/index.js",\r "groupTitle": "User_Profile_Resources"\r },\r {\r "type": "post",\r "url": "/api/userProfile/sections",\r "title": "Creates a new User Profile Section",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateUser_Profile_Sections",\r "group": "User_Profile_Sections",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "category",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "sectionId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enabled",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "autoAssociation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "crudPermissions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileSection/index.js",\r "groupTitle": "User_Profile_Sections"\r },\r {\r "type": "delete",\r "url": "/api/userProfile/sections/{id}",\r "title": "Deletes a User Profile Section",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteUser_Profile_Sections",\r "group": "User_Profile_Sections",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileSection/index.js",\r "groupTitle": "User_Profile_Sections"\r },\r {\r "type": "get",\r "url": "/api/userProfile/sections/describe",\r "title": "Gets table info about User Profile Sections",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeUser_Profile_Sections",\r "group": "User_Profile_Sections",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileSection/index.js",\r "groupTitle": "User_Profile_Sections"\r },\r {\r "type": "get",\r "url": "/api/userProfile/sections",\r "title": "Gets a list of User Profile Sections",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetUser_Profile_Sections",\r "group": "User_Profile_Sections",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileSection/index.js",\r "groupTitle": "User_Profile_Sections"\r },\r {\r "type": "get",\r "url": "/api/userProfile/sections/{id}",\r "title": "Gets a single User Profile Section",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowUser_Profile_Sections",\r "group": "User_Profile_Sections",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileSection/index.js",\r "groupTitle": "User_Profile_Sections"\r },\r {\r "type": "put",\r "url": "/api/userProfile/sections/{id}",\r "title": "Update an existing User Profile Section",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateUser_Profile_Sections",\r "group": "User_Profile_Sections",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfileSection/index.js",\r "groupTitle": "User_Profile_Sections"\r },\r {\r "type": "post",\r "url": "/api/userProfiles/{id}/resources",\r "title": "Add resources' permissions to User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddResources",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "post",\r "url": "/api/userProfiles/{id}/sections",\r "title": "Add sections' permissions to User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddSections",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "post",\r "url": "/api/userProfiles/clone",\r "title": "Clone an existing User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CloneUser_Profiles",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "post",\r "url": "/api/userProfiles",\r "title": "Creates a new User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateUser_Profiles",\r "group": "User_Profiles",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "crudPermissions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "delete",\r "url": "/api/userProfiles/{id}",\r "title": "Deletes a User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteUser_Profiles",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "get",\r "url": "/api/userProfiles/describe",\r "title": "Gets table info about User Profiles",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeUser_Profiles",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "get",\r "url": "/api/userProfiles/{id}/resources?section={section}",\r "title": "Get Resources assigned to a Section",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetResources",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "get",\r "url": "/api/userProfiles/{id}/sections",\r "title": "Get sections associated to a User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSections",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "get",\r "url": "/api/userProfiles",\r "title": "Gets a list of User Profiles",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetUser_Profiles",\r "group": "User_Profiles",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "delete",\r "url": "/api/userProfiles/{id}/resources",\r "title": "Removes resources' permissions from User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveResources",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "delete",\r "url": "/api/userProfiles/{id}/sections",\r "title": "Removes sections' permissions from User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSections",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "get",\r "url": "/api/userProfiles/{id}",\r "title": "Gets a single User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowUser_Profiles",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "put",\r "url": "/api/userProfiles/{id}",\r "title": "Update an existing User Profile",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateUser_Profiles",\r "group": "User_Profiles",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/userProfile/index.js",\r "groupTitle": "User_Profiles"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/chat_interactions",\r "title": "Add chat interaction tabs to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddChatInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/chat_websites",\r "title": "Add a Chat Website to a user",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddChatWebsites",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/contacts",\r "title": "Add contacts to a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddContacts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/fax_accounts",\r "title": "Add a Fax Account to a user",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddFaxAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/fax_interactions",\r "title": "Add fax interaction tabs to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddFaxInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/mail_accounts",\r "title": "Add a Mail Account to a user",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddMailAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/mail_interactions",\r "title": "Add mail interaction tabs to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddMailInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/openchannel_accounts",\r "title": "Add a Open Channel Account to a user",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddOpenchannelAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/openchannel_interactions",\r "title": "Add openchannel interaction tabs to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddOpenchannelInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/queues",\r "title": "Add queues to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/sms_accounts",\r "title": "Add a Sms Account to a user",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddSmsAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/sms_interactions",\r "title": "Add sms interaction tabs to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddSmsInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/square_projects",\r "title": "Add a Square Project to a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddSquareProjects",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/teams",\r "title": "Add teams to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/whatsapp_accounts",\r "title": "Add a Whatsapp Account to a user",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddWhatsappAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/whatsapp_interactions",\r "title": "Add Whatsapp interaction tabs to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddWhatsappInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "put",\r "url": "/api/users/{id}/password",\r "title": "Change user password",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "ChangePwd",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users",\r "title": "Create a new user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/api_key",\r "title": "Create a new API access key for the user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateApiKey",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}",\r "title": "Deletes a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/describe",\r "title": "Gets table info about Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/agents",\r "title": "GetAgents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/api_key",\r "title": "Get the API access key for the user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetApiKey",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/groups",\r "title": "GetChatGroups",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetChatGroups",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/chat/interactions",\r "title": "GetChatInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetChatInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/chat_websites",\r "title": "GetChatWebsites",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetChatWebsites",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/contacts",\r "title": "GetContacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetContacts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/fax_accounts",\r "title": "GetFaxAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetFaxAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/fax/interactions",\r "title": "GetFaxInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetFaxInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/lists",\r "title": "GetLists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/mail_accounts",\r "title": "GetMailAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetMailAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/mail/interactions",\r "title": "GetMailInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetMailInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/openchannel_accounts",\r "title": "GetOpenchannelAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetOpenchannelAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/openchannel/interactions",\r "title": "GetOpenchannelInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetOpenchannelInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/prefixes",\r "title": "GetPrefixes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetPrefixes",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/queues?channel={channel}",\r "title": "Gets Queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/recordings",\r "title": "GetRecordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/scheduled_calls",\r "title": "GetScheduledCalls",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetScheduledCalls",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/screen_recordings",\r "title": "GetScreenRecordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetScreenRecordings",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/sms_accounts",\r "title": "GetSmsAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSmsAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/sms/interactions",\r "title": "GetSmsInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSmsInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/square_projects",\r "title": "GetSquareProjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSquareProjects",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/teams",\r "title": "GetTeams",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users",\r "title": "Gets a list of Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetUsers",\r "group": "Users",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/queues_rt",\r "title": "GetVoiceQueuesRt",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetVoiceQueuesRt",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/whatsapp_accounts",\r "title": "GetWhatsappAccounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetWhatsappAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/whatsapp/interactions",\r "title": "GetWhatsappInteractions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetWhatsappInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/login",\r "title": "Login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Login",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/logout",\r "title": "Logout",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Logout",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/pause",\r "title": "Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Pause",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/api_key",\r "title": "Remove API access key for the user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveApiKey",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/chat_interactions",\r "title": "Removes interactions from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveChatInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/chat_websites",\r "title": "Removes a Chat Website from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveChatWebsites",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/fax_accounts",\r "title": "Removes a Fax Account from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveFaxAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/fax_interactions",\r "title": "Removes interactions from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveFaxInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/mail_accounts",\r "title": "Removes a Mail Account from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveMailAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/mail_interactions",\r "title": "Removes interactions from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveMailInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/openchannel_accounts",\r "title": "Removes a Open Channel Account from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveOpenchannelAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/openchannel_interactions",\r "title": "Removes openchannel interactions from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveOpenchannelInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/queues",\r "title": "Remove queues to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/sms_accounts",\r "title": "Removes a Sms Account from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSmsAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/sms_interactions",\r "title": "Removes interactions from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSmsInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/square_projects",\r "title": "Removes a Square Project from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSquareProjects",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/teams",\r "title": "Removes teams from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/whatsapp_accounts",\r "title": "Removes a Whatsapp Account from a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveWhatsappAccounts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/whatsapp_interactions",\r "title": "Removes Whatsapp interactions from an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveWhatsappInteractions",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}",\r "title": "Gets a single User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/unpause",\r "title": "Unpause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Unpause",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/whoami",\r "title": "WhoAmI",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "WhoAmI",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/avatar",\r "title": "Add avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAvatar",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/create_many",\r "title": "Create Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "bulkCreate",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/avatar",\r "title": "Get avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAvatar",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "put",\r "url": "/api/users/{id}",\r "title": "Update an existing User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/variables",\r "title": "Creates a new Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateVariables",\r "group": "Variables",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "delete",\r "url": "/api/variables/{id}",\r "title": "Deletes a Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/variables",\r "title": "Gets a list of Variables",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVariables",\r "group": "Variables",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/variables/{id}",\r "title": "Gets a single Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "put",\r "url": "/api/variables/{id}",\r "title": "Update an existing Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/version/fetch",\r "title": "Fetch git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "FetchVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git fetch origin master</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version",\r "title": "Gets version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVersion",\r "group": "Version",\r "description": "<p>Motion returns the current and latest motion version.</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/migrations",\r "title": "Launch database migrations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "MigrateVersion",\r "group": "Version",\r "description": "<p>Motion launch the database migrations, according to the application version</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/pull",\r "title": "Pull git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "PullVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git pull</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/reset",\r "title": "Reset git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ResetVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/restart",\r "title": "Restart motion2 after update",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RestartVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: pm2 restart motion</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports/describe",\r "title": "Gets table info about Agent Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports",\r "title": "Gets a list of Agent Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports/{id}",\r "title": "Gets a single Agent Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports/describe",\r "title": "Gets table info about Call Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports",\r "title": "Gets a list of Call Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports/{id}",\r "title": "Gets a single Call Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "put",\r "url": "/api/voice/calls/reports/{id}",\r "title": "Update a single cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/chanspy",\r "title": "Creates a new ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateChanSpy",\r "group": "Voice_ChanSpy",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "prefix",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "record",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordingFormat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "delete",\r "url": "/api/voice/chanspy/{id}",\r "title": "Deletes a ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "get",\r "url": "/api/voice/chanspy",\r "title": "Gets a list of ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "get",\r "url": "/api/voice/chanspy/{id}",\r "title": "Gets a single ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "put",\r "url": "/api/voice/chanspy/{id}",\r "title": "Update an existing ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "post",\r "url": "/api/voice/contexts",\r "title": "Create a new context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Voice_Contexts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultEntry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "delete",\r "url": "/api/voice/contexts/{id}",\r "title": "Deletes a context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/contexts",\r "title": "Gets a list of Contexts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetContexts",\r "group": "Voice_Contexts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/contexts/{id}",\r "title": "Gets a single Context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowContexts",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "put",\r "url": "/api/voice/contexts/{id}",\r "title": "Update an existing context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports/describe",\r "title": "Gets table info about Dial Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports",\r "title": "Gets a list of Dial Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports/{id}",\r "title": "Gets a single Dial Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "delete",\r "url": "/api/voice/extensions/{id}",\r "title": "Deletes a Extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "get",\r "url": "/api/voice/extensions",\r "title": "Gets a list of Extensions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "get",\r "url": "/api/voice/extensions/{id}",\r "title": "Gets a single Extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/extensions",\r "title": "Create new applications",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/extensions",\r "title": "Create an extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "put",\r "url": "/api/voice/extensions/{id}",\r "title": "Update an extension",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/mohs",\r "title": "Create a new a new MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddMoh",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "post",\r "url": "/api/voice/mohs/{id}/sounds",\r "title": "Add sound to MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddSound",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "delete",\r "url": "/api/voice/mohs/{id}",\r "title": "Deletes an MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DestroyMoh",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs",\r "title": "Gets a list of Music On Holds",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs/{id}/sounds",\r "title": "Gets sounds from MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "GetSounds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "delete",\r "url": "/api/voice/mohs/{id}/sounds/{id2}",\r "title": "Remove sound from MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSound",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs/{id}",\r "title": "Gets a single Music On Hold",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "put",\r "url": "/api/voice/mohs/{id}",\r "title": "Update an existing Music On Hold",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "post",\r "url": "/api/voice/mails",\r "title": "Creates a new Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMails",\r "group": "Voice_Mails",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customer_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pager",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tz",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "attach",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "saycid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "review",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "envelope",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "sayduration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "saydurationm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "sendvoicemail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "delete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "nextaftercmd",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "forcename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "forcegreetings",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "hidefromdir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "stamp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailsubject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailbody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "maxsecs",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "maxmsg",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "delete",\r "url": "/api/voice/mails/{id}",\r "title": "Deletes a Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails",\r "title": "Gets a list of Mails",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/{id}",\r "title": "Gets a single Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/{id}/messages",\r "title": "Gets voice mail messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "put",\r "url": "/api/voice/mails/{id}",\r "title": "Update an existing Mail",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "post",\r "url": "/api/voice/mails/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Voice_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "msgnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "macrocontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "origtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailboxuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailboxcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "recording",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "flag",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "msg_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "stamp",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "delete",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "voice/mails/messages/{id}/download",\r "title": "Download Voice Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "put",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "post",\r "url": "/api/voice/prefixes/{id}/users",\r "title": "Add agents to a prefix",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "delete",\r "url": "/api/voice/prefixes/{id}",\r "title": "Deletes a Prefix",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeletePrefixes",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "get",\r "url": "/api/voice/prefixes/describe",\r "title": "Gets table info about Prefixes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribePrefixes",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "get",\r "url": "/api/voice/prefixes/{id}/users",\r "title": "Gets agents from prefix",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "get",\r "url": "/api/voice/prefixes",\r "title": "Gets a list of Prefixes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPrefixes",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "delete",\r "url": "/api/voice/prefixes/{id}/users",\r "title": "Removes agents from a prefix",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "get",\r "url": "/api/voice/prefixes/{id}",\r "title": "Gets a single Prefix",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowPrefixes",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "put",\r "url": "/api/voice/prefixes/{id}",\r "title": "Update an existing prefix",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "post",\r "url": "/api/voice/prefixes",\r "title": "Create a prefix",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Voice_Prefixes",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voicePrefix/index.js",\r "groupTitle": "Voice_Prefixes"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/describe",\r "title": "Gets table info about Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports",\r "title": "Gets a list of Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/{id}",\r "title": "Gets a single Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/index",\r "title": "Get Voice Queues Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getVoiceQueuesReport",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/users",\r "title": "Add agents to queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Add blacklists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Add lists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Add teams to queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/clone",\r "title": "Clone an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CloneQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Voice_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"inbound\"",\r "\"outbound\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "musiconhold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rr\"",\r "\"ringall\"",\r "\"leastrecent\"",\r "\"fewestcalls\"",\r "\"random\"",\r "\"rrmemory\"",\r "\"linear\"",\r "\"wrandom\"",\r "\"rrordered\""\r ],\r "optional": false,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "servicelevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "penaltymemberslimit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeoutpriority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "weight",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "wrapuptime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autofill",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"all\""\r ],\r "optional": true,\r "field": "autopause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "autopausedelay",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autopausebusy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autopauseunavail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxlen",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setinterfacevar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setqueueentryvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setqueuevar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "eventmemberstatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membermacro",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membergosub",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "min_announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "periodic_announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "random_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "relative_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"once\""\r ],\r "optional": true,\r "field": "announce_holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "announce_position",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "announce_to_first_user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "announce_position_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"0\"",\r "\"5\"",\r "\"10\"",\r "\"15\"",\r "\"20\"",\r "\"30\""\r ],\r "optional": true,\r "field": "announce_round_seconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "monitor_format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "monitor_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_youarenext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_thereare",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_callswaiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_minute",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_minutes",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_seconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_thankyou",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_reporthold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_quantity1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_quantity2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_less_than",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinempty",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leavewhenempty",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "reportholdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ringinuse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberdelay",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "timeoutrestart",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultrule",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "acw",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "acwTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialActive",\r "description": "<p>Active/Disactive Campaign</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"preview\"",\r "\"progressive\"",\r "\"power\"",\r "\"predictive\"",\r "\"booked\""\r ],\r "optional": true,\r "field": "dialMethod",\r "description": "<p>Dial Method.</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialLimitChannel",\r "description": "<p>Max 9999 channels, 0 means unlimited.</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialLimitQueue",\r "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "dialPowerLevel",\r "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agentBusyFactor\"",\r "\"dropRate\""\r ],\r "optional": true,\r "field": "dialPredictiveOptimization",\r "description": "<p>Only for predictive method.</p>"\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "dialPredictiveOptimizationPercentage",\r "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialPredictiveInterval",\r "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialOriginateTimeout",\r "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueOptions",\r "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialQueueTimeout",\r "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueProject",\r "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionMaxRetry",\r "description": "<p>#Congestion Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionRetryFrequency",\r "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyMaxRetry",\r "description": "<p>#Busy Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyRetryFrequency",\r "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerMaxRetry",\r "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerRetryFrequency",\r "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialGlobalMaxRetry",\r "description": "<p>#Global Max Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialGlobalInterval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialPrefix",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"always\"",\r "\"never\"",\r "\"onlyIfOpen\""\r ],\r "optional": true,\r "field": "dialCheckDuplicateType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialAMDActive",\r "description": "<p>Active/Disactive AMD</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDInitialSilence",\r "description": "<p>#AMD Initial Silence</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDGreeting",\r "description": "<p>#AMD Greeting</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDAfterGreetingSilence",\r "description": "<p>#AMD After Greeting Silence</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDTotalAnalysisTime",\r "description": "<p>#AMD Total Analysis Time</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDMinWordLength",\r "description": "<p>#AMD Min Word Length</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDBetweenWordsSilence",\r "description": "<p>#AMD Between Words Silence</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDMaximumNumberOfWords",\r "description": "<p>#AMD Maximum Number Of Words</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDSilenceThreshold",\r "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAMDMaximumWordLength",\r "description": "<p>#AMD Maximum Word Length</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialRecallMeTimeout",\r "description": "<p>#RecallMe Timeout (min:1)</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialRecallInQueue",\r "description": "<p>Active/Disactive Recall In Queue</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"DESC\"",\r "\"ASC\""\r ],\r "optional": true,\r "field": "dialOrderByScheduledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueProject2",\r "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialAgiAfterHangupClient",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialAgiAfterHangupAgent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialRandomLastDigitCallerIdNumber",\r "description": "<p>Random Last Digit (min:1, max:15)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCutDigit",\r "description": "<p>Cut Digit (min:1, max:15)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoSuchNumberMaxRetry",\r "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoSuchNumberRetryFrequency",\r "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialDropMaxRetry",\r "description": "<p>#Drop Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialDropRetryFrequency",\r "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAbandonedMaxRetry",\r "description": "<p>#Abandoned Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAbandonedRetryFrequency",\r "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialMachineMaxRetry",\r "description": "<p>#Machine Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialMachineRetryFrequency",\r "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAgentRejectMaxRetry",\r "description": "<p>#AgentReject Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialAgentRejectRetryFrequency",\r "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mandatoryDispositionPauseId",\r "description": "<p>Status to put when mandatory disposition is enabled</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mandatoryDisposition",\r "description": "<p>Enabled/disables mandatory dispo on a queue</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialPredictiveIntervalMaxThreshold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialPredictiveIntervalMinThreshold",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Get queue blacklists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/finals",\r "title": "Gets queue hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/hopper_histories",\r "title": "Gets queue hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/hoppers",\r "title": "Gets queue hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Get queue lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/members",\r "title": "Gets queue members",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Gets queue team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Remove blacklists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Remove lists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/blacks",\r "title": "Gets queue hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getHopperBlacks",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "put",\r "url": "/api/voice/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Voice_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userSecondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userThirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "location",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transcribeName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transcribeStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "fileUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "fileText",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "failureReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sentiment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "sPositive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "sNegative",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "sNeutral",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "sMixed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "tempSentiment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "createdAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "updatedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/describe",\r "title": "Gets table info about Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/voice/recordings/{id}",\r "title": "Delete voice recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroy",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}/downloads",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "downloads",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "post",\r "url": "/api/voice/recordings/{id}/transcribe",\r "title": "Run Transcribe Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "transcribe",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}/transcribe",\r "title": "Run Transcribe Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "transcribe",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "put",\r "url": "/api/voice/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "post",\r "url": "/api/voice/transfers/reports",\r "title": "Creates a new Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"blind\"",\r "\"attended\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "result",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereraccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererlinkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereechannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeaccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereelinkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Yes\"",\r "\"No\""\r ],\r "optional": true,\r "field": "isexternal",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Deletes a Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/transfers/reports",\r "title": "Gets a list of Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Gets a single Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Update an existing Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/vtiger/accounts",\r "title": "Creates a new Vtiger Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateVtiger_Accounts",\r "group": "Vtiger_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "moduleName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "accessKey",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/vtiger/accounts/{id}",\r "title": "Deletes a Vtiger Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVtiger_Accounts",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/accounts",\r "title": "Gets a list of Vtiger Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVtiger_Accounts",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/accounts/{id}",\r "title": "Gets a single Vtiger Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVtiger_Accounts",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/vtiger/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/vtiger/accounts/{id}",\r "title": "Update an existing Vtiger Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateVtiger_Accounts",\r "group": "Vtiger_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerAccount/index.js",\r "groupTitle": "Vtiger_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/vtiger/configurations",\r "title": "Creates a new Vtiger Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateVtiger_Configurations",\r "group": "Vtiger_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/vtiger/configurations/{id}",\r "title": "Deletes a Vtiger Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVtiger_Configurations",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/configurations",\r "title": "Gets a list of Vtiger Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVtiger_Configurations",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/configurations/{id}",\r "title": "Gets a single Vtiger Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVtiger_Configurations",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/vtiger/configurations/{id}",\r "title": "Update an existing Vtiger Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateVtiger_Configurations",\r "group": "Vtiger_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerConfiguration/index.js",\r "groupTitle": "Vtiger_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/vtiger/fields",\r "title": "Creates a new Vtiger Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateVtiger_Fields",\r "group": "Vtiger_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerField/index.js",\r "groupTitle": "Vtiger_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/vtiger/fields/{id}",\r "title": "Deletes a Vtiger Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVtiger_Fields",\r "group": "Vtiger_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerField/index.js",\r "groupTitle": "Vtiger_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/fields",\r "title": "Gets a list of Vtiger Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVtiger_Fields",\r "group": "Vtiger_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerField/index.js",\r "groupTitle": "Vtiger_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/vtiger/fields/{id}",\r "title": "Gets a single Vtiger Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVtiger_Fields",\r "group": "Vtiger_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerField/index.js",\r "groupTitle": "Vtiger_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/vtiger/fields/{id}",\r "title": "Update an existing Vtiger Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateVtiger_Fields",\r "group": "Vtiger_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intVtigerField/index.js",\r "groupTitle": "Vtiger_Fields"\r },\r {\r "type": "post",\r "url": "/api/webbar/answer",\r "title": "answer webrtc call",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_answer",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "sessionId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/webbar/calls",\r "title": "webrtc call list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_calls",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/webbar/hangup",\r "title": "hangup webrtc call",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_hangup",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "sessionId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/webbar/unhold",\r "title": "unhold webrtc call",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_hold",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "sessionId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/webbar/hold",\r "title": "hold webrtc call",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_hold",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sessionId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/webbar/originate",\r "title": "Originate new webrtc call",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_originate",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "callNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "callerId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "callbackUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/webbar/transfer",\r "title": "blind transfer webrtc call",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Web_Bar_transfer",\r "group": "WebBar",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "number",\r "optional": false,\r "field": "userId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "string",\r "optional": false,\r "field": "sessionId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "string",\r "optional": false,\r "field": "transferNumber",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/webbar/index.js",\r "groupTitle": "WebBar"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts/{id}/users",\r "title": "Add agents to a whatsapp account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Whatsapp_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"twilio\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountSid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "authToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notificationTemplate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationSound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "notificationShake",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "waitForTheAssignedAgent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "queueTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queueTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentTransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "agentTransferTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mandatoryDispositionPauseId",\r "description": "<p>Status to put when mandatory disposition is enabled</p>"\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mandatoryDisposition",\r "description": "<p>Enabled/disables mandatory dispo on a queue</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts/describe",\r "title": "Gets table info about Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAccounts",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts/{id}/users",\r "title": "Gets agents from whatsapp account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/accounts/{id}/users",\r "title": "Removes agents from a whatsapp account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/accounts/{id}/canned_answers",\r "title": "Removes canned answers from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAnswers",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/accounts/{id}/dispositions",\r "title": "Removes dispositions from account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveDispositions",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/messages/{id}/accept",\r "title": "Accepts message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "acceptMessage",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts/{id}/canned_answers",\r "title": "Creates new canned answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnswer",\r "group": "Whatsapp_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Whatsapp_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Whatsapp_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"first\"",\r "\"second\"",\r "\"third\""\r ],\r "optional": false,\r "field": "level",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts/{id}/canned_answers",\r "title": "Gets account canned answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnswers",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts/{id}/notify",\r "title": "Notify new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "notify",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion 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>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/messages/{id}/reject",\r "title": "Rejects message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "rejectMessage",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/accounts/{id}/send",\r "title": "Send new whatsapp message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendWhatsapp",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/messages/{id}/status",\r "title": "Receive message status",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",\r "type": "json"\r }\r ],\r "name": "statusMessage",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Whatsapp_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappAccount/index.js",\r "groupTitle": "Whatsapp_Accounts"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/applications",\r "title": "Creates a new Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateApplications",\r "group": "Whatsapp_Applications",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappApplication/index.js",\r "groupTitle": "Whatsapp_Applications"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Whatsapp_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappApplication/index.js",\r "groupTitle": "Whatsapp_Applications"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/applications",\r "title": "Gets a list of Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetApplications",\r "group": "Whatsapp_Applications",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappApplication/index.js",\r "groupTitle": "Whatsapp_Applications"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Whatsapp_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappApplication/index.js",\r "groupTitle": "Whatsapp_Applications"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Whatsapp_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappApplication/index.js",\r "groupTitle": "Whatsapp_Applications"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/interactions/{id}/tags",\r "title": "Add tags to the interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTags",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Whatsapp_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "closed",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secondDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "thirdDisposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "note",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "read1stAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "firstMsgDirection",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastMsgAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "lastMsgDirection",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/interactions/{id}/tags",\r "title": "Removes tags from interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTags",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Whatsapp_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/interactions/{id}/download",\r "title": "Gets interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Whatsapp_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappInteraction/index.js",\r "groupTitle": "Whatsapp_Interactions"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Whatsapp_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "read",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"in\"",\r "\"out\""\r ],\r "optional": false,\r "field": "direction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "readAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secret",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Messages"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Whatsapp_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Messages"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Whatsapp_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Messages"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Whatsapp_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Messages"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Whatsapp_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Messages"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Whatsapp_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappMessage/index.js",\r "groupTitle": "Whatsapp_Messages"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/reports/queue",\r "title": "Creates a new Whatsapp Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateWhatsapp_Queue_Reports",\r "group": "Whatsapp_Queue_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueueReport/index.js",\r "groupTitle": "Whatsapp_Queue_Reports"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/reports/queue/{id}",\r "title": "Deletes a Whatsapp Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWhatsapp_Queue_Reports",\r "group": "Whatsapp_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueueReport/index.js",\r "groupTitle": "Whatsapp_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/reports/queue/describe",\r "title": "Gets table info about Whatsapp Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeWhatsapp_Queue_Reports",\r "group": "Whatsapp_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueueReport/index.js",\r "groupTitle": "Whatsapp_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/reports/queue",\r "title": "Gets a list of Whatsapp Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetWhatsapp_Queue_Reports",\r "group": "Whatsapp_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueueReport/index.js",\r "groupTitle": "Whatsapp_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/reports/queue/{id}",\r "title": "Gets a single Whatsapp Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWhatsapp_Queue_Reports",\r "group": "Whatsapp_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueueReport/index.js",\r "groupTitle": "Whatsapp_Queue_Reports"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/reports/queue/{id}",\r "title": "Update an existing Whatsapp Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateWhatsapp_Queue_Reports",\r "group": "Whatsapp_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueueReport/index.js",\r "groupTitle": "Whatsapp_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Whatsapp_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/queues/describe",\r "title": "Gets table info about Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueues",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/queues/{id}/members",\r "title": "GetMembers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Whatsapp_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappQueue/index.js",\r "groupTitle": "Whatsapp_Queues"\r },\r {\r "type": "post",\r "url": "/api/whatsapp/reports/transfer",\r "title": "Creates a new Whatsapp Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateWhatsapp_Transfer_Reports",\r "group": "Whatsapp_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"account\"",\r "\"agent\"",\r "\"queue\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferredAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappTransferReport/index.js",\r "groupTitle": "Whatsapp_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/whatsapp/reports/transfer/{id}",\r "title": "Deletes a Whatsapp Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWhatsapp_Transfer_Reports",\r "group": "Whatsapp_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappTransferReport/index.js",\r "groupTitle": "Whatsapp_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/reports/transfer/describe",\r "title": "Gets table info about Whatsapp Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeWhatsapp_Transfer_Reports",\r "group": "Whatsapp_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappTransferReport/index.js",\r "groupTitle": "Whatsapp_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/reports/transfer",\r "title": "Gets a list of Whatsapp Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetWhatsapp_Transfer_Reports",\r "group": "Whatsapp_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappTransferReport/index.js",\r "groupTitle": "Whatsapp_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/whatsapp/reports/transfer/{id}",\r "title": "Gets a single Whatsapp Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWhatsapp_Transfer_Reports",\r "group": "Whatsapp_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappTransferReport/index.js",\r "groupTitle": "Whatsapp_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/whatsapp/reports/transfer/{id}",\r "title": "Update an existing Whatsapp Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateWhatsapp_Transfer_Reports",\r "group": "Whatsapp_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/whatsappTransferReport/index.js",\r "groupTitle": "Whatsapp_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/accounts",\r "title": "Creates a new Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"password\"",\r "\"token\""\r ],\r "optional": true,\r "field": "authType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"integrationTab\"",\r "\"newTab\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Deletes a Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts",\r "title": "Gets a list of Zendesk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Gets a single Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Update an existing Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/configurations",\r "title": "Creates a new Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Deletes a Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations",\r "title": "Gets a list of Zendesk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Gets a single Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Update an existing Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/fields",\r "title": "Creates a new Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Fields",\r "group": "Zendesk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Deletes a Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/fields",\r "title": "Gets a list of Zendesk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Gets a single Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Update an existing Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "post",\r "url": "/api/integrations/zoho/accounts",\r "title": "Creates a new Zoho Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZoho_Accounts",\r "group": "Zoho_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "zone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "code",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "refreshToken",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zoho/accounts/{id}",\r "title": "Deletes a Zoho Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZoho_Accounts",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/accounts",\r "title": "Gets a list of Zoho Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZoho_Accounts",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/accounts/{id}",\r "title": "Gets a single Zoho Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZoho_Accounts",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zoho/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/zoho/accounts/{id}",\r "title": "Update an existing Zoho Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZoho_Accounts",\r "group": "Zoho_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoAccount/index.js",\r "groupTitle": "Zoho_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zoho/configurations",\r "title": "Creates a new Zoho Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZoho_Configurations",\r "group": "Zoho_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"lead\"",\r "\"contact\"",\r "\"nothing\""\r ],\r "optional": true,\r "field": "moduleCreate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"contact_lead\"",\r "\"contact\"",\r "\"lead\""\r ],\r "optional": true,\r "field": "moduleSearch",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zoho/configurations/{id}",\r "title": "Deletes a Zoho Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZoho_Configurations",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/configurations",\r "title": "Gets a list of Zoho Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZoho_Configurations",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/configurations/{id}",\r "title": "Gets a single Zoho Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZoho_Configurations",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/zoho/configurations/{id}",\r "title": "Update an existing Zoho Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZoho_Configurations",\r "group": "Zoho_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoConfiguration/index.js",\r "groupTitle": "Zoho_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zoho/fields",\r "title": "Creates a new Zoho Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZoho_Fields",\r "group": "Zoho_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoField/index.js",\r "groupTitle": "Zoho_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zoho/fields/{id}",\r "title": "Deletes a Zoho Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZoho_Fields",\r "group": "Zoho_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoField/index.js",\r "groupTitle": "Zoho_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/fields",\r "title": "Gets a list of Zoho Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZoho_Fields",\r "group": "Zoho_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoField/index.js",\r "groupTitle": "Zoho_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zoho/fields/{id}",\r "title": "Gets a single Zoho Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZoho_Fields",\r "group": "Zoho_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoField/index.js",\r "groupTitle": "Zoho_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/zoho/fields/{id}",\r "title": "Update an existing Zoho Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZoho_Fields",\r "group": "Zoho_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZohoField/index.js",\r "groupTitle": "Zoho_Fields"\r },\r {\r "type": "post",\r "url": "/api/cdr",\r "title": "Creates a new Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCdrs",\r "group": "cdr",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "calldate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "src",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dst",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dstchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastapp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "billsec",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userfield",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sequence",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "peeraccount",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tag",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "delete",\r "url": "/api/cdr/{id}",\r "title": "Deletes a Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr/describe",\r "title": "Gets table info about Cdrs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr",\r "title": "Gets a list of Cdrs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCdrs",\r "group": "cdr",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr/{id}",\r "title": "Gets a single Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "put",\r "url": "/api/cdr/{id}",\r "title": "Update an existing Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "post",\r "url": "/api/voiceQueuesLog",\r "title": "Creates a new VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "time",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "callid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "agent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "event",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "dtm",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "delete",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Deletes a VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "get",\r "url": "/api/voiceQueuesLog",\r "title": "Gets a list of VoiceQueuesLogs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "get",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Gets a single VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "put",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Update an existing VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r }\r]
+[
+ {
+ "type": "delete",
+ "url": "/api/actions/{id}",
+ "title": "Deletes a Action",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteActions",
+ "group": "Actions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/action/index.js",
+ "groupTitle": "Actions"
+ },
+ {
+ "type": "put",
+ "url": "/api/actions/{id}",
+ "title": "Update an existing Action",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateActions",
+ "group": "Actions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/action/index.js",
+ "groupTitle": "Actions"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/custom_reports",
+ "title": "Creates a new Analytic Custom Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAnalytic_Custom_Reports",
+ "group": "Analytic_Custom_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "parent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "table",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "conditions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "joins",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/custom_reports/{id}",
+ "title": "Deletes a Analytic Custom Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAnalytic_Custom_Reports",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/custom_reports",
+ "title": "Gets a list of Analytic Custom Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAnalytic_Custom_Reports",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/custom_reports/{id}",
+ "title": "Gets a single Analytic Custom Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAnalytic_Custom_Reports",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/custom_reports/{id}/preview",
+ "title": "Report Preview",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "preview",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/custom_reports/{id}/query",
+ "title": "Report Query SQL",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "query",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/custom_reports/{id}/run",
+ "title": "Report Run",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "run",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/analytics/custom_reports/{id}",
+ "title": "Update an existing Analytic Custom Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAnalytic_Custom_Reports",
+ "group": "Analytic_Custom_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticCustomReport/index.js",
+ "groupTitle": "Analytic_Custom_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/default_reports",
+ "title": "Creates a new Analytic Default Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAnalytic_Default_Reports",
+ "group": "Analytic_Default_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "parent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "table",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "conditions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "joins",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/default_reports/{id}",
+ "title": "Deletes a Analytic Default Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAnalytic_Default_Reports",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/default_reports",
+ "title": "Gets a list of Analytic Default Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAnalytic_Default_Reports",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/default_reports/{id}",
+ "title": "Gets a single Analytic Default Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAnalytic_Default_Reports",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/default_reports/{id}/preview",
+ "title": "Report Preview",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "preview",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/default_reports/{id}/query",
+ "title": "Report Query SQL",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "query",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/default_reports/{id}/run",
+ "title": "Report Run",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "run",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/analytics/default_reports/{id}",
+ "title": "Update an existing Analytic Default Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAnalytic_Default_Reports",
+ "group": "Analytic_Default_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticDefaultReport/index.js",
+ "groupTitle": "Analytic_Default_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/extracted_reports",
+ "title": "Creates a new Analytic Extracted Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAnalytic_Extacted_Reports",
+ "group": "Analytic_Extracted_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "basename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"csv\"",
+ "\"pdf\"",
+ "\"xlsx\""
+ ],
+ "optional": false,
+ "field": "output",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "savename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "startDate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "endDate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "status",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"manual\"",
+ "\"scheduled\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "reportId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reportType",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticExtractedReport/index.js",
+ "groupTitle": "Analytic_Extracted_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/extracted_reports/{id}",
+ "title": "Deletes a Analytic Extracted Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAnalytic_Extacted_Reports",
+ "group": "Analytic_Extracted_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticExtractedReport/index.js",
+ "groupTitle": "Analytic_Extracted_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/extracted_reports",
+ "title": "Gets a list of Analytic Extacted Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAnalytic_Extacted_Reports",
+ "group": "Analytic_Extracted_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticExtractedReport/index.js",
+ "groupTitle": "Analytic_Extracted_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/extracted_reports/{id}",
+ "title": "Gets a single Analytic Extracted Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAnalytic_Extacted_Reports",
+ "group": "Analytic_Extracted_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticExtractedReport/index.js",
+ "groupTitle": "Analytic_Extracted_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/extracted_reports/{id}/download",
+ "title": "Download Extracted Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Analytic_Extracted_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticExtractedReport/index.js",
+ "groupTitle": "Analytic_Extracted_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/analytics/extracted_reports/{id}",
+ "title": "Update an existing Analytic Extracted Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAnalytic_Extacted_Reports",
+ "group": "Analytic_Extracted_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticExtractedReport/index.js",
+ "groupTitle": "Analytic_Extracted_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/field_reports/create_many",
+ "title": "Creates many Analytic Field Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "BulkCreateAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "field",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "alias",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "function",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "format",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "groupBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "orderBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "custom",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
+ "title": "Deletes many Analytic Field Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "BulkDeleteAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/field_reports",
+ "title": "Creates a new Analytic Field Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "field",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "alias",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "function",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "format",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "groupBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "orderBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "custom",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/field_reports/{id}",
+ "title": "Deletes a Analytic Field Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/field_reports",
+ "title": "Gets a list of Analytic Field Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/field_reports/{id}",
+ "title": "Gets a single Analytic Field Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/field_reports/{id}/create_many",
+ "title": "Rewrite fields set",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addFields",
+ "group": "Analytic_Field_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/analytics/field_reports/{id}",
+ "title": "Update an existing Analytic Field Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAnalytic_Field_Reports",
+ "group": "Analytic_Field_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticFieldReport/index.js",
+ "groupTitle": "Analytic_Field_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/metrics",
+ "title": "Creates a new Analytic Metrics",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAnalytic_Metric",
+ "group": "Analytic_Metrics",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "table",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "metric",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticMetric/index.js",
+ "groupTitle": "Analytic_Metrics"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/metrics/{id}",
+ "title": "Deletes a Analytic Metrics",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAnalytic_Metric",
+ "group": "Analytic_Metrics",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticMetric/index.js",
+ "groupTitle": "Analytic_Metrics"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/metrics",
+ "title": "Gets a list of Analytic Metric",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAnalytic_Metric",
+ "group": "Analytic_Metrics",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticMetric/index.js",
+ "groupTitle": "Analytic_Metrics"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/metrics/{id}",
+ "title": "Gets a single Analytic Metrics",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAnalytic_Metric",
+ "group": "Analytic_Metrics",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticMetric/index.js",
+ "groupTitle": "Analytic_Metrics"
+ },
+ {
+ "type": "put",
+ "url": "/api/analytics/metrics/{id}",
+ "title": "Update an existing Analytic Metrics",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAnalytic_Metric",
+ "group": "Analytic_Metrics",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticMetric/index.js",
+ "groupTitle": "Analytic_Metrics"
+ },
+ {
+ "type": "post",
+ "url": "/api/analytics/tree_reports",
+ "title": "Creates a new Analytic Tree Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAnalytic_Tree_Reports",
+ "group": "Analytic_Tree_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "tree",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticTreeReport/index.js",
+ "groupTitle": "Analytic_Tree_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/analytics/tree_reports/{id}",
+ "title": "Deletes a Analytic Tree Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAnalytic_Tree_Reports",
+ "group": "Analytic_Tree_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticTreeReport/index.js",
+ "groupTitle": "Analytic_Tree_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/tree_reports",
+ "title": "Gets a list of Analytic Tree Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAnalytic_Tree_Reports",
+ "group": "Analytic_Tree_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticTreeReport/index.js",
+ "groupTitle": "Analytic_Tree_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/analytics/tree_reports/{id}",
+ "title": "Gets a single Analytic Tree Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAnalytic_Tree_Reports",
+ "group": "Analytic_Tree_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticTreeReport/index.js",
+ "groupTitle": "Analytic_Tree_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/analytics/tree_reports/{id}",
+ "title": "Update an existing Analytic Tree Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAnalytic_Tree_Reports",
+ "group": "Analytic_Tree_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/analyticTreeReport/index.js",
+ "groupTitle": "Analytic_Tree_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/attachments/clone",
+ "title": "Clone an existing Attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CloneAttachments",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "delete",
+ "url": "/api/attachments/{id}",
+ "title": "Deletes a Attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAttachments",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "get",
+ "url": "/api/attachments",
+ "title": "Gets a list of Attachments",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAttachments",
+ "group": "Attachments",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "get",
+ "url": "/api/attachments/{id}",
+ "title": "Gets a single Attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAttachments",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "post",
+ "url": "/api/attachments",
+ "title": "Add attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "create",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "get",
+ "url": "/api/attachments/:id/download",
+ "title": "Download attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions/{id}/attachment_download",
+ "title": "Download attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "show",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "put",
+ "url": "/api/attachments/{id}",
+ "title": "Update an existing Attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateAttachments",
+ "group": "Attachments",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/attachment/index.js",
+ "groupTitle": "Attachments"
+ },
+ {
+ "type": "post",
+ "url": "/api/auth/local/forgot",
+ "title": "Creates a new password reset token",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Local_Forgot_Password",
+ "group": "Authentication",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "email",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/authLocal/index.js",
+ "groupTitle": "Authentication"
+ },
+ {
+ "type": "post",
+ "url": "/api/auth/local/reset/:token",
+ "title": "Reset user password",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Local_Reset_Password",
+ "group": "Authentication",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "password",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/authLocal/index.js",
+ "groupTitle": "Authentication"
+ },
+ {
+ "type": "post",
+ "url": "/api/auth/google",
+ "title": "Creates a new User token",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Local_login",
+ "group": "Authentication",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "password",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/authGoogle/index.js",
+ "groupTitle": "Authentication"
+ },
+ {
+ "type": "post",
+ "url": "/api/auth/local",
+ "title": "Creates a new User token",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Local_login",
+ "group": "Authentication",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "password",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/authLocal/index.js",
+ "groupTitle": "Authentication"
+ },
+ {
+ "type": "post",
+ "url": "/api/automations",
+ "title": "Creates a new Automation",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAutomations",
+ "group": "Automations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "status",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/automations/{id}",
+ "title": "Deletes a Automation",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAutomations",
+ "group": "Automations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "get",
+ "url": "/api/automations",
+ "title": "Gets a list of Automations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAutomations",
+ "group": "Automations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "get",
+ "url": "/api/automations/{id}",
+ "title": "Gets a single Automation",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAutomations",
+ "group": "Automations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "post",
+ "url": "/api/automations/{id}/actions",
+ "title": "Creates new actions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addActions",
+ "group": "Automations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "action",
+ "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data1",
+ "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data2",
+ "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data3",
+ "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data4",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data5",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data6",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "data7",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "post",
+ "url": "/api/automations/{id}/conditions",
+ "title": "Creates new conditions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConditions",
+ "group": "Automations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "field",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "operator",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "get",
+ "url": "/api/automations/{id}/actions",
+ "title": "Gets Automation Actions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getActions",
+ "group": "Automations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "get",
+ "url": "/api/automations/{id}/conditions",
+ "title": "Gets Automation Conditions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConditions",
+ "group": "Automations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "put",
+ "url": "/api/automations/{id}",
+ "title": "Update an existing Automation",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateAutomations",
+ "group": "Automations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/automation/index.js",
+ "groupTitle": "Automations"
+ },
+ {
+ "type": "post",
+ "url": "/api/canned_answers",
+ "title": "Create a new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Create",
+ "group": "Canned_Answers",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cannedAnswer/index.js",
+ "groupTitle": "Canned_Answers"
+ },
+ {
+ "type": "delete",
+ "url": "/api/canned_answers/{id}",
+ "title": "Deletes a Canned Answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCanned_Answers",
+ "group": "Canned_Answers",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cannedAnswer/index.js",
+ "groupTitle": "Canned_Answers"
+ },
+ {
+ "type": "get",
+ "url": "/api/canned_answers",
+ "title": "Gets a list of Canned Answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCanned_Answers",
+ "group": "Canned_Answers",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cannedAnswer/index.js",
+ "groupTitle": "Canned_Answers"
+ },
+ {
+ "type": "get",
+ "url": "/api/canned_answers/{id}",
+ "title": "Gets a single Canned Answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCanned_Answers",
+ "group": "Canned_Answers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cannedAnswer/index.js",
+ "groupTitle": "Canned_Answers"
+ },
+ {
+ "type": "put",
+ "url": "/api/canned_answers/{id}",
+ "title": "Update an existing Canned Answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateCanned_Answers",
+ "group": "Canned_Answers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cannedAnswer/index.js",
+ "groupTitle": "Canned_Answers"
+ },
+ {
+ "type": "get",
+ "url": "/chat/internal/users",
+ "title": "Gets Users Last Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getLastUsersMessages",
+ "group": "ChatInternalMessage",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "ChatInternalMessage"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Chat_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatApplication/index.js",
+ "groupTitle": "Chat_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Chat_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatApplication/index.js",
+ "groupTitle": "Chat_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Chat_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatApplication/index.js",
+ "groupTitle": "Chat_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/groups",
+ "title": "Creates a new Group",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateGroups",
+ "group": "Chat_Groups",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "write",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/groups/{id}",
+ "title": "Deletes a Group",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteGroups",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/groups/describe",
+ "title": "Gets table info about Groups",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeGroups",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/groups",
+ "title": "Gets a list of Groups",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetGroups",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/groups/{id}/members",
+ "title": "Removes members from a group",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveMembers",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/groups/{id}",
+ "title": "Gets a single Group",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowGroups",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/groups/{id}/members",
+ "title": "Add members to chat group",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addMembers",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/groups/{id}/messages",
+ "title": "Creates a new group message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/groups/{id}/members",
+ "title": "Gets Members",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMembers",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/groups/{id}/messages",
+ "title": "Gets Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/groups/{id}/unread",
+ "title": "Get unread chat group messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getUread",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/groups/{id}",
+ "title": "Update an existing Group",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateGroups",
+ "group": "Chat_Groups",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatGroup/index.js",
+ "groupTitle": "Chat_Groups"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Chat_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ratingValue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"star\"",
+ "\"thumb\""
+ ],
+ "optional": true,
+ "field": "ratingType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "ratingMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "pathTranscript",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mailTranscript",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "browserName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "browserVersion",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "osName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "osVersion",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deviceModel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deviceVendor",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deviceType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "referer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "customerIp",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "formData",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closeReason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "customerPort",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "vidaooSessionId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/interactions/{id}/abandon",
+ "title": "Abandon interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "abandon",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/interactions/{id}/close",
+ "title": "Close Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/interactions/{id}/messages",
+ "title": "Creates new messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Chat_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/interactions/{id}/attachment_upload",
+ "title": "Add attachment",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "attachmentUpload",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/interactions/{id}/vidaoo",
+ "title": "Create Vidaoo Session",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "createVidaooSession",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/interactions/{id}/custom_update",
+ "title": "Update interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "customUpdate",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions/{id}/download",
+ "title": "Gets interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/interactions/{id}/my_messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMyMessages",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/internal/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Chat_Internal_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ChatInternalMessageId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "Chat_Internal_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/internal/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Chat_Internal_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "Chat_Internal_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/internal/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Chat_Internal_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "Chat_Internal_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/internal/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Chat_Internal_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "Chat_Internal_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/internal/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Chat_Internal_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "Chat_Internal_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/internal/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Chat_Internal_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInternalMessage/index.js",
+ "groupTitle": "Chat_Internal_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Chat_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Chat_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Chat_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Chat_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Chat_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Chat_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/offline_messages",
+ "title": "Creates a new OfflineMessage",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateOfflineMessages",
+ "group": "Chat_Offline_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatOfflineMessage/index.js",
+ "groupTitle": "Chat_Offline_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/offline_messages/{id}",
+ "title": "Deletes a OfflineMessage",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteOfflineMessages",
+ "group": "Chat_Offline_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatOfflineMessage/index.js",
+ "groupTitle": "Chat_Offline_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/offline_messages/describe",
+ "title": "Gets table info about OfflineMessages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeOfflineMessages",
+ "group": "Chat_Offline_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatOfflineMessage/index.js",
+ "groupTitle": "Chat_Offline_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/offline_messages",
+ "title": "Gets a list of OfflineMessages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetOfflineMessages",
+ "group": "Chat_Offline_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatOfflineMessage/index.js",
+ "groupTitle": "Chat_Offline_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/offline_messages/{id}",
+ "title": "Gets a single OfflineMessage",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowOfflineMessages",
+ "group": "Chat_Offline_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatOfflineMessage/index.js",
+ "groupTitle": "Chat_Offline_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/offline_messages/{id}",
+ "title": "Update an existing OfflineMessage",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateOfflineMessages",
+ "group": "Chat_Offline_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatOfflineMessage/index.js",
+ "groupTitle": "Chat_Offline_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/proactive_actions",
+ "title": "Creates a new Proactive Action",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateProactive_Actions",
+ "group": "Chat_Proactive_Actions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"mouseOver\"",
+ "\"timeout\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "selector",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatProactiveAction/index.js",
+ "groupTitle": "Chat_Proactive_Actions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/proactive_actions/{id}",
+ "title": "Deletes a Proactive Action",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteProactive_Actions",
+ "group": "Chat_Proactive_Actions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatProactiveAction/index.js",
+ "groupTitle": "Chat_Proactive_Actions"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/proactive_actions/{id}",
+ "title": "Gets a single Proactive Action",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowProactive_Actions",
+ "group": "Chat_Proactive_Actions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatProactiveAction/index.js",
+ "groupTitle": "Chat_Proactive_Actions"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/proactive_actions/{id}",
+ "title": "Update an existing Proactive Action",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateProactive_Actions",
+ "group": "Chat_Proactive_Actions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatProactiveAction/index.js",
+ "groupTitle": "Chat_Proactive_Actions"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/reports/queue",
+ "title": "Creates a new Chat Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateChat_Queue_Reports",
+ "group": "Chat_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueueReport/index.js",
+ "groupTitle": "Chat_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/reports/queue/{id}",
+ "title": "Deletes a Chat Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteChat_Queue_Reports",
+ "group": "Chat_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueueReport/index.js",
+ "groupTitle": "Chat_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/reports/queue/describe",
+ "title": "Gets table info about Chat Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeChat_Queue_Reports",
+ "group": "Chat_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueueReport/index.js",
+ "groupTitle": "Chat_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/reports/queue",
+ "title": "Gets a list of Chat Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetChat_Queue_Reports",
+ "group": "Chat_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueueReport/index.js",
+ "groupTitle": "Chat_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/reports/queue/{id}",
+ "title": "Gets a single Chat Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowChat_Queue_Reports",
+ "group": "Chat_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueueReport/index.js",
+ "groupTitle": "Chat_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/reports/queue/{id}",
+ "title": "Update an existing Chat Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateChat_Queue_Reports",
+ "group": "Chat_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueueReport/index.js",
+ "groupTitle": "Chat_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Chat_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": true,
+ "field": "strategy",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Chat_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Chat_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/reports/transfer",
+ "title": "Creates a new Chat Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateChat_Transfer_Reports",
+ "group": "Chat_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatTransferReport/index.js",
+ "groupTitle": "Chat_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/reports/transfer/{id}",
+ "title": "Deletes a Chat Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteChat_Transfer_Reports",
+ "group": "Chat_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatTransferReport/index.js",
+ "groupTitle": "Chat_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/reports/transfer/describe",
+ "title": "Gets table info about Chat Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeChat_Transfer_Reports",
+ "group": "Chat_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatTransferReport/index.js",
+ "groupTitle": "Chat_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/reports/transfer",
+ "title": "Gets a list of Chat Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetChat_Transfer_Reports",
+ "group": "Chat_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatTransferReport/index.js",
+ "groupTitle": "Chat_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/reports/transfer/{id}",
+ "title": "Gets a single Chat Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowChat_Transfer_Reports",
+ "group": "Chat_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatTransferReport/index.js",
+ "groupTitle": "Chat_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/reports/transfer/{id}",
+ "title": "Update an existing Chat Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateChat_Transfer_Reports",
+ "group": "Chat_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatTransferReport/index.js",
+ "groupTitle": "Chat_Transfer_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/users",
+ "title": "Add agents to a website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites",
+ "title": "Creates a new Website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateWebsites",
+ "group": "Chat_Websites",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "address",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mapKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mapKeyOffline",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentAlias",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "customerAlias",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "color",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "color_button",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "textColor",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "fontSize",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "animation",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rounded\"",
+ "\"squared\""
+ ],
+ "optional": true,
+ "field": "header_shape",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "header_online",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "start_chat_button",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "offline_chat_button",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "header_offline",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "download_transcript",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "whiteLabel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "defaultWhiteLabel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "sitepic",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closingQuestion",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "formSubmitSuccessMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "formSubmitFailureMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "noteTitle",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "placeholderMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closingMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closingMessageButton",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "skipMessageButton",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "conditionAgreement",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableRating",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableFeedback",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableSendButton",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "feedbackTitle",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"star\"",
+ "\"thumb\""
+ ],
+ "optional": true,
+ "field": "ratingType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ratingStarsNumber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "onlineForm",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "offlineForm",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoclose",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableCustomerWriting",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "forwardTranscript",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "forwardTranscriptMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "forwardOffline",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "forwardOfflineAddress",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "waitingTitle",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "waitingMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "offlineMessageSubject",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "offlineMessageBody",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableUnmanagedNote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "unmanagedMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "skipUnmanaged",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sendUnmanaged",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableCustomerAttachment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableCustomerCheckmarks",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "agentAvatar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "showAgentAvatar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "timezone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notificationTemplate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationSound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationShake",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "hideWhenOffline",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentIdentifier",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "alignment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "verticalAlignment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messagesAlignment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "defaultTitle",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "customerAvatar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "showCustomerAvatar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "messageFontSize",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "backgroundColor",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "queueTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "queueTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "agentTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "systemAlias",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "systemAvatar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "vidaooEscalation",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "vidaooApiKey",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/websites/{id}",
+ "title": "Deletes a Website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteWebsites",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/describe",
+ "title": "Gets table info about Websites",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeWebsites",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/users",
+ "title": "Gets agents from website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites",
+ "title": "Gets a list of Websites",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetWebsites",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/websites/{id}/users",
+ "title": "Removes agents from a website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/websites/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/websites/{id}/dispositions",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}",
+ "title": "Gets a single Website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowWebsites",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Chat_Websites",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Chat_Websites",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/avatar",
+ "title": "Add avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addAvatar",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/customer_avatar",
+ "title": "Add customer avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addCustomerAvatar",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Chat_Websites",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/accounts/{id}/interactions",
+ "title": "Creates new interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addInteraction",
+ "group": "Chat_Websites",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ratingValue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"star\"",
+ "\"thumb\""
+ ],
+ "optional": true,
+ "field": "ratingType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "ratingMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "pathTranscript",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mailTranscript",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "browserName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "browserVersion",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "osName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "osVersion",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deviceModel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deviceVendor",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deviceType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "referer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "customerIp",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "formData",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closeReason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "customerPort",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "vidaooSessionId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/logo",
+ "title": "Add logo",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addLogo",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/proactive_actions",
+ "title": "Creates new Proactive Actions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addProactiveActions",
+ "group": "Chat_Websites",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"mouseOver\"",
+ "\"timeout\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "selector",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/system_avatar",
+ "title": "Add system avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addSystemAvatar",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/applications",
+ "title": "Gets Website Applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/avatar",
+ "title": "Get avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAvatar",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/customer_avatar",
+ "title": "Get Customer Avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getCustomerAvatar",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/fields",
+ "title": "Gets Website Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/interactions",
+ "title": "Gets Website Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getInteraction",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/logo",
+ "title": "Get logo",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getLogo",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/offline_messages",
+ "title": "Gets Website Offline Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getOfflineMessages",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/proactive_actions",
+ "title": "Gets Website Proactive Actions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getProactiveActions",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/snippet",
+ "title": "Gets Website Snippet",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSnippet",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "get",
+ "url": "/api/chat/websites/{id}/system_avatar",
+ "title": "Get System Avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSystemAvatar",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/notify",
+ "title": "Notify new message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "notify",
+ "group": "Chat_Websites",
+ "description": "<p>Motion 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>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/chat/websites/{id}/offline",
+ "title": "Offline message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "offline",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatMessage/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "put",
+ "url": "/api/chat/websites/{id}",
+ "title": "Update an existing Website",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateWebsites",
+ "group": "Chat_Websites",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatWebsite/index.js",
+ "groupTitle": "Chat_Websites"
+ },
+ {
+ "type": "post",
+ "url": "/api/cloudProviders",
+ "title": "Creates a new CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCloudProviders",
+ "group": "CloudProviders",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"AmazonAWS\"",
+ "\"Google\""
+ ],
+ "optional": false,
+ "field": "service",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data1",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data2",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cloudProviders/{id}",
+ "title": "Deletes a CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "get",
+ "url": "/api/cloudProviders",
+ "title": "Gets a list of CloudProviders",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "get",
+ "url": "/api/cloudProviders/{id}",
+ "title": "Gets a single CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "put",
+ "url": "/api/cloudProviders/{id}",
+ "title": "Update an existing CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/companies",
+ "title": "Creates a new Company",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCompanies",
+ "group": "Cm_Companies",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "vat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "companyId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "website",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fax",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "street",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "postalCode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "city",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "country",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "email",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "emailDomain",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sStreet",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sPostalCode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sCity",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sCountry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/companies/{id}",
+ "title": "Deletes a Company",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCompanies",
+ "group": "Cm_Companies",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/companies/describe",
+ "title": "Gets table info about Companies",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeCompanies",
+ "group": "Cm_Companies",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/companies",
+ "title": "Gets a list of Companies",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCompanies",
+ "group": "Cm_Companies",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/companies/{id}",
+ "title": "Gets a single Company",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCompanies",
+ "group": "Cm_Companies",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/companies/{id}/contacts",
+ "title": "Creates new contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addContacts",
+ "group": "Cm_Companies",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "firstName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "street",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "postalCode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "city",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "country",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dateOfBirth",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mobile",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fax",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "email",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "url",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "facebook",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fb_data",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "twitter",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "skype",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "teams",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "viber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "line",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "wechat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "telegram",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "UserId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "scheduledat",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/companies/{id}/contacts",
+ "title": "Gets List Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getContacts",
+ "group": "Cm_Companies",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/companies/{id}",
+ "title": "Update an existing Company",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateCompanies",
+ "group": "Cm_Companies",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCompany/index.js",
+ "groupTitle": "Cm_Companies"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/contacts/{id}",
+ "title": "Deletes a Contact",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteContacts",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/describe",
+ "title": "Gets table info about Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeContacts",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts",
+ "title": "Gets a list of Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetContacts",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/finals",
+ "title": "Gets contact hopper finals",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperFinals",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/hopper_histories",
+ "title": "Gets contact hopper histories",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperHistories",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/hoppers",
+ "title": "Gets contact hoppers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHoppers",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/create_many",
+ "title": "Create Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "bulkCreate",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts",
+ "title": "Create Contact",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "create",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/jscripty_sessions",
+ "title": "Gets contact hopper blacks",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getJscriptySessions",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/tags",
+ "title": "Gets configurations tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getTags",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/merge",
+ "title": "Merge Contact",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "merge",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/{id}/tags",
+ "title": "Sets new tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "setTags",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}",
+ "title": "Gets a single Contact",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "show",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/contacts/{id}",
+ "title": "Update a single Contact",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/custom_fields/{id}",
+ "title": "Deletes a Custom Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCustom_Fields",
+ "group": "Cm_Custom_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCustomField/index.js",
+ "groupTitle": "Cm_Custom_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/custom_fields",
+ "title": "Gets a list of Custom Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCustom_Fields",
+ "group": "Cm_Custom_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCustomField/index.js",
+ "groupTitle": "Cm_Custom_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/custom_fields/{id}",
+ "title": "Gets a single Custom Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCustom_Fields",
+ "group": "Cm_Custom_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCustomField/index.js",
+ "groupTitle": "Cm_Custom_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/custom_fields/{id}",
+ "title": "Update an existing Custom Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateCustom_Fields",
+ "group": "Cm_Custom_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCustomField/index.js",
+ "groupTitle": "Cm_Custom_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/hopper",
+ "title": "Creates a new Hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateHopper",
+ "group": "Cm_Hopper",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "active",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "scheduledat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countbusyretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countcongestionretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnoanswerretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "callback",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callbackuniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callbackat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "recallme",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ContactId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ListId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "UserId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "VoiceQueueId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "CampaignId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnosuchnumberretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countdropretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countabandonedretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countmachineretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countagentrejectretry",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper/describe",
+ "title": "Gets table info about Hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeHopper",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper",
+ "title": "Gets a list of Hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopper",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper/{id}",
+ "title": "Gets a single Hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowHopper",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/hopper_black/{id}",
+ "title": "Deletes a Hopper Black",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteHopper_Black",
+ "group": "Cm_Hopper_Black",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperBlack/index.js",
+ "groupTitle": "Cm_Hopper_Black"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_black/describe",
+ "title": "Gets table info about Hopper Black",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeHopper_Black",
+ "group": "Cm_Hopper_Black",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperBlack/index.js",
+ "groupTitle": "Cm_Hopper_Black"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_black",
+ "title": "Gets a list of Hopper Black",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopper_Black",
+ "group": "Cm_Hopper_Black",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperBlack/index.js",
+ "groupTitle": "Cm_Hopper_Black"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_black/{id}",
+ "title": "Gets a single Hopper Black",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowHopper_Black",
+ "group": "Cm_Hopper_Black",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperBlack/index.js",
+ "groupTitle": "Cm_Hopper_Black"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/hopper_black/{id}",
+ "title": "Update an existing Hopper Black",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateHopper_Black",
+ "group": "Cm_Hopper_Black",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperBlack/index.js",
+ "groupTitle": "Cm_Hopper_Black"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/hopper_final/checkContactHopper",
+ "title": "Check if contact is in hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "/checkContactHopper",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_final/describe",
+ "title": "Gets table info about HopperFinal",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_final",
+ "title": "Gets a list of HopperFinal",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_final/{id}",
+ "title": "Gets a single HopperFinal",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
+ "title": "Return number contacts for attributes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "countContactsIvrCampaignHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
+ "title": "Return number contacts for attributes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "countContactsQueueCampaignHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/hopper_final/campaign/{id}",
+ "title": "Move contacts in hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "moveContactsIvrCampaignHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/hopper_final/voice/queue/{id}",
+ "title": "Move contacts in hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "moveContactsQueueCampaignHopperFinal",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/hopper_final/{id}",
+ "title": "Update a single hopper final",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "Cm_Hopper_Final",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperFinal/index.js",
+ "groupTitle": "Cm_Hopper_Final"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/hopper_history",
+ "title": "Creates a new HopperHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateHopperHistory",
+ "group": "Cm_Hopper_History",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "state",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "statedesc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "scheduledat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countbusyretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countcongestionretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnoanswerretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countglobal",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "originatecalleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "originatecalleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "starttime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "responsetime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "answertime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "droptime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "endtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ringtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "holdtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "talktime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "followuptime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dropreason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "campaign",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "campaigntype",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membername",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "amd",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "fax",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "callback",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callbackuniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callbackat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "recallme",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "editedat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "edited",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnosuchnumberretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countdropretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countabandonedretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countmachineretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countagentrejectretry",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperHistory/index.js",
+ "groupTitle": "Cm_Hopper_History"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_history/describe",
+ "title": "Gets table info about HopperHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeHopperHistory",
+ "group": "Cm_Hopper_History",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperHistory/index.js",
+ "groupTitle": "Cm_Hopper_History"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_history",
+ "title": "Gets a list of HopperHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperHistory",
+ "group": "Cm_Hopper_History",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperHistory/index.js",
+ "groupTitle": "Cm_Hopper_History"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper_history/{id}",
+ "title": "Gets a single HopperHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowHopperHistory",
+ "group": "Cm_Hopper_History",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperHistory/index.js",
+ "groupTitle": "Cm_Hopper_History"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/hopper_history/{id}",
+ "title": "Update a single hopper history",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "Cm_Hopper_History",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperHistory/index.js",
+ "groupTitle": "Cm_Hopper_History"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/hopper/{id}",
+ "title": "Delete Hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "destroy",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper/opencontacts",
+ "title": "Gets Open Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getOpenContacts",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/hopper/preview",
+ "title": "Gets Preview Dialer Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getPreview",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/hopper/{id}",
+ "title": "Update an existing Hopper",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateHopper",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/lists",
+ "title": "Creates a new List",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateLists",
+ "group": "Cm_Lists",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialPrefix",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/lists/{id}",
+ "title": "Deletes a List",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteLists",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/describe",
+ "title": "Gets table info about Lists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeLists",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/{id}/users",
+ "title": "Gets agents from list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists",
+ "title": "Gets a list of Lists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetLists",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/lists/{id}/users",
+ "title": "Removes agents from a list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm/lists/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/{id}",
+ "title": "Gets a single List",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowLists",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/lists/{id}/users",
+ "title": "Adds agents to a list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAgents",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/lists/{id}/contacts",
+ "title": "Creates new contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addContacts",
+ "group": "Cm_Lists",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "firstName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "street",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "postalCode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "city",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "country",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dateOfBirth",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mobile",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fax",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "email",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "url",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "facebook",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fb_data",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "twitter",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "skype",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "teams",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "viber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "line",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "wechat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "telegram",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "UserId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "scheduledat",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/lists/{id}/fields",
+ "title": "Creates a new custom field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addCustomField",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/lists/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Cm_Lists",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/{id}/contacts",
+ "title": "Gets List Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getContacts",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/{id}/fields",
+ "title": "Gets Custom Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getCustomFields",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/{id}/dispositions",
+ "title": "Gets list dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/lists/{id}/contacts/csv",
+ "title": "Gets CSV List Contacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "grunt",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm/lists/{id}",
+ "title": "Update an existing List",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateLists",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/upload/:id",
+ "title": "Import new contacts by csv",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "import",
+ "group": "Cm_contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/upload",
+ "title": "Upload csv",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "upload",
+ "group": "Cm_contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/csv",
+ "title": "Create new contacts by csv",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "uploadCsv",
+ "group": "Cm_contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_contacts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/conditions/{id}",
+ "title": "Deletes a Condition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteConditions",
+ "group": "Conditions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/condition/index.js",
+ "groupTitle": "Conditions"
+ },
+ {
+ "type": "put",
+ "url": "/api/conditions/{id}",
+ "title": "Update an existing Condition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateConditions",
+ "group": "Conditions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/condition/index.js",
+ "groupTitle": "Conditions"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/custom_field",
+ "title": "Create a new custom field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCustomField",
+ "group": "Custom_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmCustomField/index.js",
+ "groupTitle": "Custom_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/dashboards/items",
+ "title": "Create dasboard item",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "Create",
+ "group": "Dashboard_Items",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboardItem/index.js",
+ "groupTitle": "Dashboard_Items"
+ },
+ {
+ "type": "delete",
+ "url": "/api/dashboards/items/{id}",
+ "title": "Deletes a Dashboard Item",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDashboard_Items",
+ "group": "Dashboard_Items",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboardItem/index.js",
+ "groupTitle": "Dashboard_Items"
+ },
+ {
+ "type": "get",
+ "url": "/api/dashboards/items/{id}",
+ "title": "Gets a single Dashboard Item",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDashboard_Items",
+ "group": "Dashboard_Items",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboardItem/index.js",
+ "groupTitle": "Dashboard_Items"
+ },
+ {
+ "type": "put",
+ "url": "/api/dashboards/items/{id}",
+ "title": "Update an existing item",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "Update",
+ "group": "Dashboard_Items",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboardItem/index.js",
+ "groupTitle": "Dashboard_Items"
+ },
+ {
+ "type": "post",
+ "url": "/api/dashboards/clone",
+ "title": "Clone an existing Dashboard",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CloneDashboards",
+ "group": "Dashboards",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "post",
+ "url": "/api/dashboards",
+ "title": "Creates a new Dashboard",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDashboards",
+ "group": "Dashboards",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "delete",
+ "url": "/api/dashboards/{id}",
+ "title": "Deletes a Dashboard",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDashboards",
+ "group": "Dashboards",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "get",
+ "url": "/api/dashboards",
+ "title": "Gets a list of Dashboards",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDashboards",
+ "group": "Dashboards",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "get",
+ "url": "/api/dashboards/{id}",
+ "title": "Gets a single Dashboard",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDashboards",
+ "group": "Dashboards",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "post",
+ "url": "/api/dashboards/{id}/items",
+ "title": "Creates new item",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addItem",
+ "group": "Dashboards",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "get",
+ "url": "/api/dashboards/{id}/items",
+ "title": "Gets items",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getItems",
+ "group": "Dashboards",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "put",
+ "url": "/api/dashboards/{id}",
+ "title": "Update an existing Dashboard",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateDashboards",
+ "group": "Dashboards",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/dashboard/index.js",
+ "groupTitle": "Dashboards"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/desk/accounts",
+ "title": "Creates a new Desk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDesk_Accounts",
+ "group": "Desk_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"basic\""
+ ],
+ "optional": true,
+ "field": "authType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "consumerKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "consumerSecret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "tokenSecret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"integrationTab\"",
+ "\"newTab\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/desk/accounts/{id}",
+ "title": "Deletes a Desk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDesk_Accounts",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/accounts",
+ "title": "Gets a list of Desk Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDesk_Accounts",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/accounts/{id}",
+ "title": "Gets a single Desk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDesk_Accounts",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/desk/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/desk/accounts/{id}",
+ "title": "Update an existing Desk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateDesk_Accounts",
+ "group": "Desk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskAccount/index.js",
+ "groupTitle": "Desk_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/desk/configurations",
+ "title": "Creates a new Desk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDesk_Configurations",
+ "group": "Desk_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/desk/configurations/{id}",
+ "title": "Deletes a Desk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDesk_Configurations",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/configurations",
+ "title": "Gets a list of Desk Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDesk_Configurations",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/configurations/{id}",
+ "title": "Gets a single Desk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDesk_Configurations",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/configurations/{id}/tags",
+ "title": "Gets configurations tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getTags",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/desk/configurations/{id}/tags",
+ "title": "Sets new tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "setTags",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/desk/configurations/{id}",
+ "title": "Update an existing Desk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateDesk_Configurations",
+ "group": "Desk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskConfiguration/index.js",
+ "groupTitle": "Desk_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/desk/fields",
+ "title": "Creates a new Desk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDesk_Fields",
+ "group": "Desk_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskField/index.js",
+ "groupTitle": "Desk_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/desk/fields/{id}",
+ "title": "Deletes a Desk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDesk_Fields",
+ "group": "Desk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskField/index.js",
+ "groupTitle": "Desk_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/fields",
+ "title": "Gets a list of Desk Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDesk_Fields",
+ "group": "Desk_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskField/index.js",
+ "groupTitle": "Desk_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/desk/fields/{id}",
+ "title": "Gets a single Desk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDesk_Fields",
+ "group": "Desk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskField/index.js",
+ "groupTitle": "Desk_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/desk/fields/{id}",
+ "title": "Update an existing Desk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateDesk_Fields",
+ "group": "Desk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDeskField/index.js",
+ "groupTitle": "Desk_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/dispositions",
+ "title": "Creates a new Disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDispositions",
+ "group": "Dispositions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/disposition/index.js",
+ "groupTitle": "Dispositions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/dispositions/{id}",
+ "title": "Deletes a Disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDispositions",
+ "group": "Dispositions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/disposition/index.js",
+ "groupTitle": "Dispositions"
+ },
+ {
+ "type": "get",
+ "url": "/api/dispositions",
+ "title": "Gets a list of Dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDispositions",
+ "group": "Dispositions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/disposition/index.js",
+ "groupTitle": "Dispositions"
+ },
+ {
+ "type": "get",
+ "url": "/api/dispositions/{id}",
+ "title": "Gets a single Disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDispositions",
+ "group": "Dispositions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/disposition/index.js",
+ "groupTitle": "Dispositions"
+ },
+ {
+ "type": "put",
+ "url": "/api/dispositions/{id}",
+ "title": "Update an existing Disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateDispositions",
+ "group": "Dispositions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/disposition/index.js",
+ "groupTitle": "Dispositions"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/dynamics365/accounts",
+ "title": "Creates a new Dynamics365 Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDynamics365_Accounts",
+ "group": "Dynamics365_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "tenantId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clientId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clientSecret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/dynamics365/accounts/{id}",
+ "title": "Deletes a Dynamics365 Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDynamics365_Accounts",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/accounts",
+ "title": "Gets a list of Dynamics365 Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDynamics365_Accounts",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/accounts/{id}",
+ "title": "Gets a single Dynamics365 Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDynamics365_Accounts",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/dynamics365/accounts/{id}",
+ "title": "Update an existing Dynamics365 Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateDynamics365_Accounts",
+ "group": "Dynamics365_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Account/index.js",
+ "groupTitle": "Dynamics365_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/dynamics365/configurations",
+ "title": "Creates a new Dynamics365 Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDynamics365_Configurations",
+ "group": "Dynamics365_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"incident\"",
+ "\"phonecall\""
+ ],
+ "optional": true,
+ "field": "ticketType",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/dynamics365/configurations/{id}",
+ "title": "Deletes a Dynamics365 Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDynamics365_Configurations",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/configurations",
+ "title": "Gets a list of Dynamics365 Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDynamics365_Configurations",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/configurations/{id}",
+ "title": "Gets a single Dynamics365 Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDynamics365_Configurations",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/dynamics365/configurations/{id}",
+ "title": "Update an existing Dynamics365 Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateDynamics365_Configurations",
+ "group": "Dynamics365_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Configuration/index.js",
+ "groupTitle": "Dynamics365_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/dynamics365/fields",
+ "title": "Creates a new Dynamics365 Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateDynamics365_Fields",
+ "group": "Dynamics365_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Field/index.js",
+ "groupTitle": "Dynamics365_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/dynamics365/fields/{id}",
+ "title": "Deletes a Dynamics365 Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteDynamics365_Fields",
+ "group": "Dynamics365_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Field/index.js",
+ "groupTitle": "Dynamics365_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/fields",
+ "title": "Gets a list of Dynamics365 Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDynamics365_Fields",
+ "group": "Dynamics365_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Field/index.js",
+ "groupTitle": "Dynamics365_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/dynamics365/fields/{id}",
+ "title": "Gets a single Dynamics365 Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDynamics365_Fields",
+ "group": "Dynamics365_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Field/index.js",
+ "groupTitle": "Dynamics365_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/dynamics365/fields/{id}",
+ "title": "Update an existing Dynamics365 Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateDynamics365_Fields",
+ "group": "Dynamics365_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intDynamics365Field/index.js",
+ "groupTitle": "Dynamics365_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/{id}/users",
+ "title": "Add agents to a fax account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts",
+ "title": "Creates a new Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAccounts",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "ecm",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "headerinfo",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "localstationid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"2400\"",
+ "\"4800\"",
+ "\"7200\"",
+ "\"9600\"",
+ "\"12000\"",
+ "\"14400\""
+ ],
+ "optional": true,
+ "field": "minrate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"2400\"",
+ "\"4800\"",
+ "\"7200\"",
+ "\"9600\"",
+ "\"12000\"",
+ "\"14400\""
+ ],
+ "optional": true,
+ "field": "maxrate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "modem",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "gateway",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "faxdetect",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "t38timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"SIP\"",
+ "\"IAX\"",
+ "\"DADHI\"",
+ "\"KHOMP\""
+ ],
+ "optional": true,
+ "field": "tech",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notificationTemplate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationSound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationShake",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "queueTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "queueTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "agentTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/accounts/{id}",
+ "title": "Deletes a Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAccounts",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAccounts",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts",
+ "title": "Gets a list of Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAccounts",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}/users",
+ "title": "Gets agents from fax account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/accounts/{id}/users",
+ "title": "Removes agents from a fax account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/accounts/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/accounts/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}",
+ "title": "Gets a single Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAccounts",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/addaccountapplications",
+ "title": "Creates new account and applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/{id}/interactions",
+ "title": "Creates new interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addInteraction",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fax",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}/applications",
+ "title": "Gets account pplications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}/interactions",
+ "title": "Gets account interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getInteraction",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/accounts/{id}/messages",
+ "title": "Gets account messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/{id}/send",
+ "title": "Send new fax",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "sendFax",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/accounts/{id}",
+ "title": "Update an existing Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAccounts",
+ "group": "Fax_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/accounts/updateaccountapplications",
+ "title": "Update account and applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Fax_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxAccount/index.js",
+ "groupTitle": "Fax_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/applications",
+ "title": "Creates a new Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateApplications",
+ "group": "Fax_Applications",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxApplication/index.js",
+ "groupTitle": "Fax_Applications"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Fax_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxApplication/index.js",
+ "groupTitle": "Fax_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/applications",
+ "title": "Gets a list of Applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetApplications",
+ "group": "Fax_Applications",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxApplication/index.js",
+ "groupTitle": "Fax_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Fax_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxApplication/index.js",
+ "groupTitle": "Fax_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Fax_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxApplication/index.js",
+ "groupTitle": "Fax_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Fax_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fax",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/interactions/{id}/messages",
+ "title": "Creates new messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Fax_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "failMessage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/interactions/{id}/download",
+ "title": "Get interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Fax_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxInteraction/index.js",
+ "groupTitle": "Fax_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/messages/{id}/download",
+ "title": "Get message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Fax_Message",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Message"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/messages",
+ "title": "Create message and send Fax",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Fax_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxMessage/index.js",
+ "groupTitle": "Fax_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/reports/queue",
+ "title": "Creates a new Fax Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFax_Queue_Reports",
+ "group": "Fax_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueueReport/index.js",
+ "groupTitle": "Fax_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/reports/queue/{id}",
+ "title": "Deletes a Fax Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFax_Queue_Reports",
+ "group": "Fax_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueueReport/index.js",
+ "groupTitle": "Fax_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/reports/queue/describe",
+ "title": "Gets table info about Fax Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeFax_Queue_Reports",
+ "group": "Fax_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueueReport/index.js",
+ "groupTitle": "Fax_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/reports/queue",
+ "title": "Gets a list of Fax Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFax_Queue_Reports",
+ "group": "Fax_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueueReport/index.js",
+ "groupTitle": "Fax_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/reports/queue/{id}",
+ "title": "Gets a single Fax Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFax_Queue_Reports",
+ "group": "Fax_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueueReport/index.js",
+ "groupTitle": "Fax_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/reports/queue/{id}",
+ "title": "Update an existing Fax Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFax_Queue_Reports",
+ "group": "Fax_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueueReport/index.js",
+ "groupTitle": "Fax_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Fax_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": false,
+ "field": "strategy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "lastAgent",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Fax_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Fax_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/fax/reports/transfer",
+ "title": "Creates a new Fax Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFax_Transfer_Reports",
+ "group": "Fax_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxTransferReport/index.js",
+ "groupTitle": "Fax_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/reports/transfer/{id}",
+ "title": "Deletes a Fax Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFax_Transfer_Reports",
+ "group": "Fax_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxTransferReport/index.js",
+ "groupTitle": "Fax_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/reports/transfer/describe",
+ "title": "Gets table info about Fax Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeFax_Transfer_Reports",
+ "group": "Fax_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxTransferReport/index.js",
+ "groupTitle": "Fax_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/reports/transfer",
+ "title": "Gets a list of Fax Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFax_Transfer_Reports",
+ "group": "Fax_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxTransferReport/index.js",
+ "groupTitle": "Fax_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/fax/reports/transfer/{id}",
+ "title": "Gets a single Fax Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFax_Transfer_Reports",
+ "group": "Fax_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxTransferReport/index.js",
+ "groupTitle": "Fax_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/fax/reports/transfer/{id}",
+ "title": "Update an existing Fax Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFax_Transfer_Reports",
+ "group": "Fax_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxTransferReport/index.js",
+ "groupTitle": "Fax_Transfer_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshdesk/accounts",
+ "title": "Creates a new Freshdesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFreshdesk_Accounts",
+ "group": "Freshdesk_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "apiKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/freshdesk/accounts/{id}",
+ "title": "Deletes a Freshdesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFreshdesk_Accounts",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/accounts",
+ "title": "Gets a list of Freshdesk Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFreshdesk_Accounts",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/accounts/{id}",
+ "title": "Gets a single Freshdesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFreshdesk_Accounts",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/freshdesk/accounts/{id}",
+ "title": "Update an existing Freshdesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFreshdesk_Accounts",
+ "group": "Freshdesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskAccount/index.js",
+ "groupTitle": "Freshdesk_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshdesk/configurations",
+ "title": "Creates a new Freshdesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFreshdesk_Configurations",
+ "group": "Freshdesk_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/freshdesk/configurations/{id}",
+ "title": "Deletes a Freshdesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFreshdesk_Configurations",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/configurations",
+ "title": "Gets a list of Freshdesk Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFreshdesk_Configurations",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/configurations/{id}",
+ "title": "Gets a single Freshdesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFreshdesk_Configurations",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/configurations/{id}/tags",
+ "title": "Gets configurations tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getTags",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshdesk/configurations/{id}/tags",
+ "title": "Sets new tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "setTags",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/freshdesk/configurations/{id}",
+ "title": "Update an existing Freshdesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFreshdesk_Configurations",
+ "group": "Freshdesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskConfiguration/index.js",
+ "groupTitle": "Freshdesk_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshdesk/fields",
+ "title": "Creates a new Freshdesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFreshdesk_Fields",
+ "group": "Freshdesk_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskField/index.js",
+ "groupTitle": "Freshdesk_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/freshdesk/fields/{id}",
+ "title": "Deletes a Freshdesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFreshdesk_Fields",
+ "group": "Freshdesk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskField/index.js",
+ "groupTitle": "Freshdesk_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/fields",
+ "title": "Gets a list of Freshdesk Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFreshdesk_Fields",
+ "group": "Freshdesk_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskField/index.js",
+ "groupTitle": "Freshdesk_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshdesk/fields/{id}",
+ "title": "Gets a single Freshdesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFreshdesk_Fields",
+ "group": "Freshdesk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskField/index.js",
+ "groupTitle": "Freshdesk_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/freshdesk/fields/{id}",
+ "title": "Update an existing Freshdesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFreshdesk_Fields",
+ "group": "Freshdesk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshdeskField/index.js",
+ "groupTitle": "Freshdesk_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshsales/accounts",
+ "title": "Creates a new Freshsales Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFreshsales_Accounts",
+ "group": "Freshsales_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "apiKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/freshsales/accounts/{id}",
+ "title": "Deletes a Freshsales Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFreshsales_Accounts",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/accounts",
+ "title": "Gets a list of Freshsales Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFreshsales_Accounts",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/accounts/{id}",
+ "title": "Gets a single Freshsales Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFreshsales_Accounts",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshsales/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/freshsales/accounts/{id}",
+ "title": "Update an existing Freshsales Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFreshsales_Accounts",
+ "group": "Freshsales_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesAccount/index.js",
+ "groupTitle": "Freshsales_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshsales/configurations",
+ "title": "Creates a new Freshsales Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFreshsales_Configurations",
+ "group": "Freshsales_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/freshsales/configurations/{id}",
+ "title": "Deletes a Freshsales Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFreshsales_Configurations",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/configurations",
+ "title": "Gets a list of Freshsales Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFreshsales_Configurations",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/configurations/{id}",
+ "title": "Gets a single Freshsales Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFreshsales_Configurations",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/freshsales/configurations/{id}",
+ "title": "Update an existing Freshsales Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFreshsales_Configurations",
+ "group": "Freshsales_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesConfiguration/index.js",
+ "groupTitle": "Freshsales_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/freshsales/fields",
+ "title": "Creates a new Freshsales Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateFreshsales_Fields",
+ "group": "Freshsales_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesField/index.js",
+ "groupTitle": "Freshsales_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/freshsales/fields/{id}",
+ "title": "Deletes a Freshsales Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteFreshsales_Fields",
+ "group": "Freshsales_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesField/index.js",
+ "groupTitle": "Freshsales_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/fields",
+ "title": "Gets a list of Freshsales Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetFreshsales_Fields",
+ "group": "Freshsales_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesField/index.js",
+ "groupTitle": "Freshsales_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/freshsales/fields/{id}",
+ "title": "Gets a single Freshsales Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowFreshsales_Fields",
+ "group": "Freshsales_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesField/index.js",
+ "groupTitle": "Freshsales_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/freshsales/fields/{id}",
+ "title": "Update an existing Freshsales Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateFreshsales_Fields",
+ "group": "Freshsales_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intFreshsalesField/index.js",
+ "groupTitle": "Freshsales_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/campaigns/{id}/blacklists",
+ "title": "Add blacklists to an IVR campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddBlackLists",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "post",
+ "url": "/api/campaigns/{id}/lists",
+ "title": "Add lists to an IVR campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddLists",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "post",
+ "url": "/api/campaigns/clone",
+ "title": "Clone an existing IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CloneIVR_Campaigns",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "post",
+ "url": "/api/campaigns",
+ "title": "Creates a new IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateIVR_Campaigns",
+ "group": "IVR_Campaigns",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"ivr\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "active",
+ "description": "<p>Active/Disactive Campaign</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "limitCalls",
+ "description": "<p>Max 200 calls.</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialOriginateCallerIdName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialOriginateCallerIdNumber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialOriginateTimeout",
+ "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialCongestionMaxRetry",
+ "description": "<p>#Congestion Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialCongestionRetryFrequency",
+ "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialBusyMaxRetry",
+ "description": "<p>#Busy Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialBusyRetryFrequency",
+ "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoAnswerMaxRetry",
+ "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoAnswerRetryFrequency",
+ "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialGlobalMaxRetry",
+ "description": "<p>#Global Max Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialTimezone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialGlobalInterval",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"always\"",
+ "\"never\"",
+ "\"onlyIfOpen\""
+ ],
+ "optional": true,
+ "field": "dialCheckDuplicateType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialAMDActive",
+ "description": "<p>Active/Disactive AMD</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDInitialSilence",
+ "description": "<p>#AMD Initial Silence</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDGreeting",
+ "description": "<p>#AMD Greeting</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDAfterGreetingSilence",
+ "description": "<p>#AMD After Greeting Silence</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDTotalAnalysisTime",
+ "description": "<p>#AMD Total Analysis Time</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDMinWordLength",
+ "description": "<p>#AMD Min Word Length</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDBetweenWordsSilence",
+ "description": "<p>#AMD Between Words Silence</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDMaximumNumberOfWords",
+ "description": "<p>#AMD Maximum Number Of Words</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDSilenceThreshold",
+ "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDMaximumWordLength",
+ "description": "<p>#AMD Maximum Word Length</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"DESC\"",
+ "\"ASC\""
+ ],
+ "optional": true,
+ "field": "dialOrderByScheduledAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialPrefix",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialRandomLastDigitCallerIdNumber",
+ "description": "<p>Random Last Digit (min:1, max:15)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialCutDigit",
+ "description": "<p>Cut Digit (min:1, max:15)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberMaxRetry",
+ "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberRetryFrequency",
+ "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropMaxRetry",
+ "description": "<p>#Drop Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropRetryFrequency",
+ "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedMaxRetry",
+ "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedRetryFrequency",
+ "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineMaxRetry",
+ "description": "<p>#Machine Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineRetryFrequency",
+ "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectMaxRetry",
+ "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectRetryFrequency",
+ "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "delete",
+ "url": "/api/campaigns/{id}",
+ "title": "Deletes a IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteIVR_Campaigns",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}/blacklists",
+ "title": "Get IVR campaign blacklists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetBlackLists",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}/finals",
+ "title": "Gets IVR campaign hopper finals",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperFinals",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}/hopper_histories",
+ "title": "Gets IVR campaign hopper histories",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperHistories",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}/hoppers",
+ "title": "Gets IVR campaign hoppers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHoppers",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns",
+ "title": "Gets a list of IVR Campaigns",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetIVR_Campaigns",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}/lists",
+ "title": "Get IVR campaign lists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetLists",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "delete",
+ "url": "/api/campaigns/{id}/blacklists",
+ "title": "Remove blacklists from an IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveBlackLists",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "delete",
+ "url": "/api/campaigns/{id}/lists",
+ "title": "Remove lists from an IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveLists",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}",
+ "title": "Gets a single IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowIVR_Campaigns",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "get",
+ "url": "/api/campaigns/{id}/blacks",
+ "title": "Gets IVR campaign hopper blacks",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getHopperBlacks",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "put",
+ "url": "/api/campaigns/{id}",
+ "title": "Update an existing IVR Campaign",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateIVR_Campaigns",
+ "group": "IVR_Campaigns",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/campaign/index.js",
+ "groupTitle": "IVR_Campaigns"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/reports",
+ "title": "Creates a new Integration Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateIntegration_Reports",
+ "group": "Integration_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "integration",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "eventChannel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitStatus",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "ticketId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "integrationId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "contacts",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interface",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membername",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentcalledAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentconnectAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "holdtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentcomplete",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentcompleteAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "talktime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentacw",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "acwtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentringnoanswer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentringnoanswerAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentdump",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "agentdumpAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastevent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "channelstate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channelstatedesc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "connectedlinenum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "connectedlinename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "language",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destchannel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "destchannelstate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destchannelstatedesc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destcalleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destcalleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destconnectedlinenum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destconnectedlinename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destlanguage",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destaccountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destcontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destexten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destpriority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "destuniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "inReplyTo",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "subject",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "to",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "cc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "attachment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "html",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "text",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"SENT\"",
+ "\"SENDING\"",
+ "\"RECEIVED\"",
+ "\"FAILED\""
+ ],
+ "optional": true,
+ "field": "status",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "url",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "projectId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/integrationReport/index.js",
+ "groupTitle": "Integration_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/reports/{id}",
+ "title": "Deletes a Integration Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteIntegration_Reports",
+ "group": "Integration_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/integrationReport/index.js",
+ "groupTitle": "Integration_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/reports/describe",
+ "title": "Gets table info about Integration Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeIntegration_Reports",
+ "group": "Integration_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/integrationReport/index.js",
+ "groupTitle": "Integration_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/reports",
+ "title": "Gets a list of Integration Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetIntegration_Reports",
+ "group": "Integration_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/integrationReport/index.js",
+ "groupTitle": "Integration_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/reports/{id}",
+ "title": "Gets a single Integration Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowIntegration_Reports",
+ "group": "Integration_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/integrationReport/index.js",
+ "groupTitle": "Integration_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/reports/{id}",
+ "title": "Update an existing Integration Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateIntegration_Reports",
+ "group": "Integration_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/integrationReport/index.js",
+ "groupTitle": "Integration_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/intervals",
+ "title": "Creates a new Interval",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateIntervals",
+ "group": "Intervals",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "delete",
+ "url": "/api/intervals/{id}",
+ "title": "Deletes a Interval",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteIntervals",
+ "group": "Intervals",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "get",
+ "url": "/api/intervals",
+ "title": "Gets a list of Intervals",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetIntervals",
+ "group": "Intervals",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "get",
+ "url": "/api/intervals/{id}",
+ "title": "Gets a single Interval",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowIntervals",
+ "group": "Intervals",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "post",
+ "url": "/api/intervals/{id}/sub_intervals",
+ "title": "Creates a new sub interval",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addInterval",
+ "group": "Intervals",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "post",
+ "url": "/api/intervals/{id}/sub_intervals/create_many",
+ "title": "Create new sub intervals set",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addIntervals",
+ "group": "Intervals",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "get",
+ "url": "/api/intervals/{id}/sub_intervals",
+ "title": "Get sub intervals set",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getIntervals",
+ "group": "Intervals",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "put",
+ "url": "/api/intervals/{id}",
+ "title": "Update an existing Interval",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateIntervals",
+ "group": "Intervals",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/interval/index.js",
+ "groupTitle": "Intervals"
+ },
+ {
+ "type": "post",
+ "url": "/api/jira",
+ "title": "Creates a new issue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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}",
+ "type": "json"
+ }
+ ],
+ "name": "Creates_Issue",
+ "group": "Issue",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"Bug\""
+ ],
+ "optional": true,
+ "field": "issuetype",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "summary",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jira/index.js",
+ "groupTitle": "Issue"
+ },
+ {
+ "type": "post",
+ "url": "/api/jscripty/answers/reports",
+ "title": "Creates a new Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateReports",
+ "group": "JscriptyAnswerReport",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "question",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "answer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membername",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "projectname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "questionId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyAnswerReport/index.js",
+ "groupTitle": "JscriptyAnswerReport"
+ },
+ {
+ "type": "delete",
+ "url": "/api/jscripty/answers/reports/{id}",
+ "title": "Deletes a Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteReports",
+ "group": "JscriptyAnswerReport",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyAnswerReport/index.js",
+ "groupTitle": "JscriptyAnswerReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/answers/reports/describe",
+ "title": "Gets table info about Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeReports",
+ "group": "JscriptyAnswerReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyAnswerReport/index.js",
+ "groupTitle": "JscriptyAnswerReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/answers/reports",
+ "title": "Gets a list of Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetReports",
+ "group": "JscriptyAnswerReport",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyAnswerReport/index.js",
+ "groupTitle": "JscriptyAnswerReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/answers/reports/{id}",
+ "title": "Gets a single Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowReports",
+ "group": "JscriptyAnswerReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyAnswerReport/index.js",
+ "groupTitle": "JscriptyAnswerReport"
+ },
+ {
+ "type": "put",
+ "url": "/api/jscripty/answers/reports/{id}",
+ "title": "Update an existing Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateReports",
+ "group": "JscriptyAnswerReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyAnswerReport/index.js",
+ "groupTitle": "JscriptyAnswerReport"
+ },
+ {
+ "type": "post",
+ "url": "/api/jscripty/questions/reports",
+ "title": "Creates a new Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateReports",
+ "group": "JscriptyQuestionReport",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "question",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "answer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membername",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "projectname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "questionId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyQuestionReport/index.js",
+ "groupTitle": "JscriptyQuestionReport"
+ },
+ {
+ "type": "delete",
+ "url": "/api/jscripty/questions/reports/{id}",
+ "title": "Deletes a Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteReports",
+ "group": "JscriptyQuestionReport",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyQuestionReport/index.js",
+ "groupTitle": "JscriptyQuestionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/questions/reports/describe",
+ "title": "Gets table info about Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeReports",
+ "group": "JscriptyQuestionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyQuestionReport/index.js",
+ "groupTitle": "JscriptyQuestionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/questions/reports",
+ "title": "Gets a list of Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetReports",
+ "group": "JscriptyQuestionReport",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyQuestionReport/index.js",
+ "groupTitle": "JscriptyQuestionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/questions/reports/{id}",
+ "title": "Gets a single Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowReports",
+ "group": "JscriptyQuestionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyQuestionReport/index.js",
+ "groupTitle": "JscriptyQuestionReport"
+ },
+ {
+ "type": "put",
+ "url": "/api/jscripty/questions/reports/{id}",
+ "title": "Update an existing Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateReports",
+ "group": "JscriptyQuestionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyQuestionReport/index.js",
+ "groupTitle": "JscriptyQuestionReport"
+ },
+ {
+ "type": "post",
+ "url": "/api/jscripty/sessions/reports",
+ "title": "Creates a new Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateReports",
+ "group": "JscriptySessionReport",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "starttime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "endtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membername",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "projectname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "completed",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "delete",
+ "url": "/api/jscripty/sessions/reports/{id}",
+ "title": "Deletes a Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteReports",
+ "group": "JscriptySessionReport",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/sessions/reports/describe",
+ "title": "Gets table info about Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeReports",
+ "group": "JscriptySessionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/sessions/reports",
+ "title": "Gets a list of Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetReports",
+ "group": "JscriptySessionReport",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/sessions/reports/{id}",
+ "title": "Gets a single Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowReports",
+ "group": "JscriptySessionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/sessions/reports/{id}/questions",
+ "title": "Gets Jscripty Session questions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getQuestions",
+ "group": "JscriptySessionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "put",
+ "url": "/api/jscripty/sessions/reports/{id}",
+ "title": "Update an existing Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateReports",
+ "group": "JscriptySessionReport",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptySessionReport/index.js",
+ "groupTitle": "JscriptySessionReport"
+ },
+ {
+ "type": "post",
+ "url": "/api/jscripty/projects/clone",
+ "title": "Clone an existing Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CloneProjects",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "post",
+ "url": "/api/jscripty/projects",
+ "title": "Creates a new Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateProjects",
+ "group": "Jscripty_Projects",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "formData",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enableUncompleteSave",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "sendUnpauseOnSubmit",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "delete",
+ "url": "/api/jscripty/projects/{id}",
+ "title": "Deletes a Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteProjects",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/projects",
+ "title": "Gets a list of Projects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetProjects",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/projects/{id}",
+ "title": "Gets a single Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowProjects",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/projects/{id}/answers",
+ "title": "Gets jscripty project answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/projects/{id}/sessions",
+ "title": "Gets jscripty project sessions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSessions",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/jscripty/projects/{id}/summary",
+ "title": "Gets jscripty project summary",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSummary",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "put",
+ "url": "/api/jscripty/projects/{id}",
+ "title": "Update an existing Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateProjects",
+ "group": "Jscripty_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/jscriptyProject/index.js",
+ "groupTitle": "Jscripty_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/license",
+ "title": "Gets License Info",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "index",
+ "group": "License",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/license/index.js",
+ "groupTitle": "License"
+ },
+ {
+ "type": "put",
+ "url": "/api/license/{id}",
+ "title": "Update License Info",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "License",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/license/index.js",
+ "groupTitle": "License"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/users",
+ "title": "Add agents to a mail account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/in_servers",
+ "title": "Creates a new IMAP server",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddImap",
+ "group": "Mail_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "host",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "authentication",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "user",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "port",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "tls",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mailbox",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "connTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "authTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "service",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/out_servers",
+ "title": "Creates a new SMTP server",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddSmtp",
+ "group": "Mail_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "host",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "user",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "pass",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "port",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secure",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "service",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "authentication",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/accounts/{id}",
+ "title": "Deletes a mail account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMailAccounts",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAccounts",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts",
+ "title": "Gets a list of Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAccounts",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/users",
+ "title": "Gets agents from mail account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/in_servers",
+ "title": "Gets account IMAP server",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetImap",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/out_servers",
+ "title": "Gets account SMTP server",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetSmtp",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/accounts/{id}/users",
+ "title": "Removes agents from a mail account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/accounts/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/accounts/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/accounts/{id}/in_servers",
+ "title": "Removes IMAP server from an account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveImmap",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/accounts/{id}/out_servers",
+ "title": "Removes SMTP server from an account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveSmtp",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}",
+ "title": "Gets a single Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAccounts",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Mail_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Mail_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Mail_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/interactions",
+ "title": "Creates new interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addInteraction",
+ "group": "Mail_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "inReplyTo",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "to",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "cc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "subject",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "attach",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "substatus",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "substatusAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "lastMsgBody",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "lastMsgText",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts",
+ "title": "Create a mail account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "create",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/applications",
+ "title": "Gets account applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/interactions",
+ "title": "Gets account interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getInteraction",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/messages",
+ "title": "Gets account messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/accounts/{id}/send",
+ "title": "Send new mail",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "sendMail",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/accounts/{id}",
+ "title": "Update an existing Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAccounts",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/accounts/{id}/verify",
+ "title": "Verify mail account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "verifySmtp",
+ "group": "Mail_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailAccount/index.js",
+ "groupTitle": "Mail_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Mail_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailApplication/index.js",
+ "groupTitle": "Mail_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Mail_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailApplication/index.js",
+ "groupTitle": "Mail_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Mail_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailApplication/index.js",
+ "groupTitle": "Mail_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Mail_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "inReplyTo",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "to",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "cc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "subject",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "attach",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "substatus",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "substatusAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "lastMsgBody",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "lastMsgText",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/interactions/{id}/messages",
+ "title": "Creates new message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Mail_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "plainBody",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "to",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "cc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "bcc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "subject",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sentAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "attach",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "originTo",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "originCc",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/interactions/{id}/download",
+ "title": "Gets interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Mail_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteraction/index.js",
+ "groupTitle": "Mail_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/messages",
+ "title": "Create a message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "createMessage",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/messages/{id}/download",
+ "title": "Gets message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Mail_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailMessage/index.js",
+ "groupTitle": "Mail_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/reports/queue",
+ "title": "Creates a new Mail Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMail_Queue_Reports",
+ "group": "Mail_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueueReport/index.js",
+ "groupTitle": "Mail_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/reports/queue/{id}",
+ "title": "Deletes a Mail Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMail_Queue_Reports",
+ "group": "Mail_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueueReport/index.js",
+ "groupTitle": "Mail_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/reports/queue/describe",
+ "title": "Gets table info about Mail Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMail_Queue_Reports",
+ "group": "Mail_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueueReport/index.js",
+ "groupTitle": "Mail_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/reports/queue",
+ "title": "Gets a list of Mail Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMail_Queue_Reports",
+ "group": "Mail_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueueReport/index.js",
+ "groupTitle": "Mail_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/reports/queue/{id}",
+ "title": "Gets a single Mail Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMail_Queue_Reports",
+ "group": "Mail_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueueReport/index.js",
+ "groupTitle": "Mail_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/reports/queue/{id}",
+ "title": "Update an existing Mail Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMail_Queue_Reports",
+ "group": "Mail_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueueReport/index.js",
+ "groupTitle": "Mail_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Mail_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": true,
+ "field": "strategy",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Mail_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Mail_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/out_servers",
+ "title": "Creates a new SMTP",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSMTPs",
+ "group": "Mail_SMTP",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "host",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "user",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "pass",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "port",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secure",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "service",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "authentication",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailServerOut/index.js",
+ "groupTitle": "Mail_SMTP"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/out_servers/{id}",
+ "title": "Deletes a SMTP",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSMTPs",
+ "group": "Mail_SMTP",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailServerOut/index.js",
+ "groupTitle": "Mail_SMTP"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/out_servers",
+ "title": "Gets a list of SMTPs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSMTPs",
+ "group": "Mail_SMTP",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailServerOut/index.js",
+ "groupTitle": "Mail_SMTP"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/out_servers/{id}",
+ "title": "Gets a single SMTP",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSMTPs",
+ "group": "Mail_SMTP",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailServerOut/index.js",
+ "groupTitle": "Mail_SMTP"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/out_servers/{id}",
+ "title": "Update an existing SMTP",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSMTPs",
+ "group": "Mail_SMTP",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailServerOut/index.js",
+ "groupTitle": "Mail_SMTP"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/substatuses",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSubstatuses",
+ "group": "Mail_Substatuses",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailSubstatus/index.js",
+ "groupTitle": "Mail_Substatuses"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/substatuses/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSubstatuses",
+ "group": "Mail_Substatuses",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailSubstatus/index.js",
+ "groupTitle": "Mail_Substatuses"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/substatuses/describe",
+ "title": "Gets table info about Substatuses",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeSubstatuses",
+ "group": "Mail_Substatuses",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailSubstatus/index.js",
+ "groupTitle": "Mail_Substatuses"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/substatuses",
+ "title": "Gets a list of Substatuses",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSubstatuses",
+ "group": "Mail_Substatuses",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailSubstatus/index.js",
+ "groupTitle": "Mail_Substatuses"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/substatuses/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSubstatuses",
+ "group": "Mail_Substatuses",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailSubstatus/index.js",
+ "groupTitle": "Mail_Substatuses"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/substatuses/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSubstatuses",
+ "group": "Mail_Substatuses",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailSubstatus/index.js",
+ "groupTitle": "Mail_Substatuses"
+ },
+ {
+ "type": "post",
+ "url": "/api/mail/reports/transfer",
+ "title": "Creates a new Mail Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMail_Transfer_Reports",
+ "group": "Mail_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailTransferReport/index.js",
+ "groupTitle": "Mail_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/reports/transfer/{id}",
+ "title": "Deletes a Mail Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMail_Transfer_Reports",
+ "group": "Mail_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailTransferReport/index.js",
+ "groupTitle": "Mail_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/reports/transfer/describe",
+ "title": "Gets table info about Mail Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMail_Transfer_Reports",
+ "group": "Mail_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailTransferReport/index.js",
+ "groupTitle": "Mail_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/reports/transfer",
+ "title": "Gets a list of Mail Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMail_Transfer_Reports",
+ "group": "Mail_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailTransferReport/index.js",
+ "groupTitle": "Mail_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/mail/reports/transfer/{id}",
+ "title": "Gets a single Mail Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMail_Transfer_Reports",
+ "group": "Mail_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailTransferReport/index.js",
+ "groupTitle": "Mail_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/mail/reports/transfer/{id}",
+ "title": "Update an existing Mail Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMail_Transfer_Reports",
+ "group": "Mail_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailTransferReport/index.js",
+ "groupTitle": "Mail_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/members/reports/describe",
+ "title": "Gets table info about Member Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMember_Reports",
+ "group": "Member_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/memberReport/index.js",
+ "groupTitle": "Member_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/members/reports",
+ "title": "Gets a list of Member Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMember_Reports",
+ "group": "Member_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/memberReport/index.js",
+ "groupTitle": "Member_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/members/reports/{id}",
+ "title": "Gets a single Member Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMember_Reports",
+ "group": "Member_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/memberReport/index.js",
+ "groupTitle": "Member_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/migrations",
+ "title": "Gets a list of Migrations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMigrations",
+ "group": "Migrations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/migration/index.js",
+ "groupTitle": "Migrations"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/networks",
+ "title": "Create a new network",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Create",
+ "group": "Networks",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/network/index.js",
+ "groupTitle": "Networks"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/networks/{id}",
+ "title": "Deletes a network",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "Delete",
+ "group": "Networks",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/network/index.js",
+ "groupTitle": "Networks"
+ },
+ {
+ "type": "get",
+ "url": "/api/networks",
+ "title": "Gets a list of Networks",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetNetworks",
+ "group": "Networks",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/network/index.js",
+ "groupTitle": "Networks"
+ },
+ {
+ "type": "get",
+ "url": "/api/networks/{id}",
+ "title": "Gets a single Network",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowNetworks",
+ "group": "Networks",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/network/index.js",
+ "groupTitle": "Networks"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/networks/{id}",
+ "title": "Update an existing network",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "Update",
+ "group": "Networks",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/network/index.js",
+ "groupTitle": "Networks"
+ },
+ {
+ "type": "post",
+ "url": "/api/notifications",
+ "title": "Send notification to user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Send",
+ "group": "Notifications",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/notification/index.js",
+ "groupTitle": "Notifications"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts/{id}/users",
+ "title": "Add agents to a openchannel account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts",
+ "title": "Creates a new Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAccounts",
+ "group": "Openchannel_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "replyUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notificationTemplate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationSound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationShake",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mapKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "queueTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "queueTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "agentTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/accounts/{id}",
+ "title": "Deletes a Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAccounts",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAccounts",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts",
+ "title": "Gets a list of Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAccounts",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/{id}/users",
+ "title": "Gets agents from openchannel account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/accounts/{id}/users",
+ "title": "Removes agents from a openchannel account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/accounts/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/accounts/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/{id}",
+ "title": "Gets a single Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAccounts",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Openchannel_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Openchannel_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Openchannel_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/{id}/applications",
+ "title": "Gets account applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/accounts/{id}/interactions",
+ "title": "Gets Openchannel Account Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getInteractions",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts/{id}/notify",
+ "title": "Notify new message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "notify",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/accounts/{id}/send",
+ "title": "Send new openchannel message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "sendOpenchannel",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/accounts/{id}",
+ "title": "Update an existing Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAccounts",
+ "group": "Openchannel_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelAccount/index.js",
+ "groupTitle": "Openchannel_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/applications",
+ "title": "Creates a new Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateApplications",
+ "group": "Openchannel_Applications",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelApplication/index.js",
+ "groupTitle": "Openchannel_Applications"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Openchannel_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelApplication/index.js",
+ "groupTitle": "Openchannel_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/applications",
+ "title": "Gets a list of Applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetApplications",
+ "group": "Openchannel_Applications",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelApplication/index.js",
+ "groupTitle": "Openchannel_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Openchannel_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelApplication/index.js",
+ "groupTitle": "Openchannel_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Openchannel_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelApplication/index.js",
+ "groupTitle": "Openchannel_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Openchannel_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "threadId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "externalUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/interactions/{id}/messages",
+ "title": "Creates new messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Openchannel_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/interactions/{id}/download",
+ "title": "Gets interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Openchannel_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelInteraction/index.js",
+ "groupTitle": "Openchannel_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Openchannel_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Openchannel_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelMessage/index.js",
+ "groupTitle": "Openchannel_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/reports/queue",
+ "title": "Creates a new Openchannel Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateOpenchannel_Queue_Reports",
+ "group": "Openchannel_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueueReport/index.js",
+ "groupTitle": "Openchannel_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/reports/queue/{id}",
+ "title": "Deletes a Openchannel Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteOpenchannel_Queue_Reports",
+ "group": "Openchannel_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueueReport/index.js",
+ "groupTitle": "Openchannel_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/reports/queue/describe",
+ "title": "Gets table info about Openchannel Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeOpenchannel_Queue_Reports",
+ "group": "Openchannel_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueueReport/index.js",
+ "groupTitle": "Openchannel_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/reports/queue",
+ "title": "Gets a list of Openchannel Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetOpenchannel_Queue_Reports",
+ "group": "Openchannel_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueueReport/index.js",
+ "groupTitle": "Openchannel_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/reports/queue/{id}",
+ "title": "Gets a single Openchannel Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowOpenchannel_Queue_Reports",
+ "group": "Openchannel_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueueReport/index.js",
+ "groupTitle": "Openchannel_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/reports/queue/{id}",
+ "title": "Update an existing Openchannel Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateOpenchannel_Queue_Reports",
+ "group": "Openchannel_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueueReport/index.js",
+ "groupTitle": "Openchannel_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Openchannel_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": true,
+ "field": "strategy",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Openchannel_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Openchannel_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/openchannel/reports/transfer",
+ "title": "Creates a new Openchannel Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateOpenchannel_Transfer_Reports",
+ "group": "Openchannel_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelTransferReport/index.js",
+ "groupTitle": "Openchannel_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/reports/transfer/{id}",
+ "title": "Deletes a Openchannel Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteOpenchannel_Transfer_Reports",
+ "group": "Openchannel_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelTransferReport/index.js",
+ "groupTitle": "Openchannel_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/reports/transfer/describe",
+ "title": "Gets table info about Openchannel Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeOpenchannel_Transfer_Reports",
+ "group": "Openchannel_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelTransferReport/index.js",
+ "groupTitle": "Openchannel_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/reports/transfer",
+ "title": "Gets a list of Openchannel Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetOpenchannel_Transfer_Reports",
+ "group": "Openchannel_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelTransferReport/index.js",
+ "groupTitle": "Openchannel_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/openchannel/reports/transfer/{id}",
+ "title": "Gets a single Openchannel Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowOpenchannel_Transfer_Reports",
+ "group": "Openchannel_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelTransferReport/index.js",
+ "groupTitle": "Openchannel_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/openchannel/reports/transfer/{id}",
+ "title": "Update an existing Openchannel Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateOpenchannel_Transfer_Reports",
+ "group": "Openchannel_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelTransferReport/index.js",
+ "groupTitle": "Openchannel_Transfer_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/pauses",
+ "title": "Creates a new Pause",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreatePauses",
+ "group": "Pauses",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pause/index.js",
+ "groupTitle": "Pauses"
+ },
+ {
+ "type": "delete",
+ "url": "/api/pauses/{id}",
+ "title": "Deletes a Pause",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeletePauses",
+ "group": "Pauses",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pause/index.js",
+ "groupTitle": "Pauses"
+ },
+ {
+ "type": "get",
+ "url": "/api/pauses",
+ "title": "Gets a list of Pauses",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetPauses",
+ "group": "Pauses",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/pause/index.js",
+ "groupTitle": "Pauses"
+ },
+ {
+ "type": "get",
+ "url": "/api/pauses/{id}",
+ "title": "Gets a single Pause",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowPauses",
+ "group": "Pauses",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pause/index.js",
+ "groupTitle": "Pauses"
+ },
+ {
+ "type": "put",
+ "url": "/api/pauses/{id}",
+ "title": "Update an existing Pause",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updatePauses",
+ "group": "Pauses",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pause/index.js",
+ "groupTitle": "Pauses"
+ },
+ {
+ "type": "get",
+ "url": "/api/plugins",
+ "title": "Gets a list of Plugins",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetPlugins",
+ "group": "Plugins",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "get",
+ "url": "/api/plugins/{id}",
+ "title": "Gets a single Plugin",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowPlugins",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "delete",
+ "url": "/api/plugins/{id}",
+ "title": "Delete a plugin",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "destroyPlugin",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "get",
+ "url": "/api/plugins/{id}/download",
+ "title": "Download plugin source code",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "put",
+ "url": "/api/plugins/{id}",
+ "title": "Update an existing plugin",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updatePlugin",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "post",
+ "url": "/api/plugins",
+ "title": "Upload new plugin",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "uploadPlugin",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "post",
+ "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
+ "title": "Redirect a plugin request to the specified path",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "webhookPlugin",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "get",
+ "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
+ "title": "Redirect a plugin request to the specified path",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "webhookPlugin",
+ "group": "Plugins",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/plugin/index.js",
+ "groupTitle": "Plugins"
+ },
+ {
+ "type": "delete",
+ "url": "/api/pm2/{id}",
+ "title": "Deletes an existing process",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeletePm2Process",
+ "group": "Pm2",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pm2/index.js",
+ "groupTitle": "Pm2"
+ },
+ {
+ "type": "get",
+ "url": "/api/pm2/{id}",
+ "title": "Gets a single pm2 process",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetPm2Process",
+ "group": "Pm2",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pm2/index.js",
+ "groupTitle": "Pm2"
+ },
+ {
+ "type": "get",
+ "url": "/api/pm2",
+ "title": "Gets pm2 processes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetPm2Processes",
+ "group": "Pm2",
+ "description": "<p>Motion returns the pm2 processes list.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pm2/index.js",
+ "groupTitle": "Pm2"
+ },
+ {
+ "type": "post",
+ "url": "/api/pm2",
+ "title": "Start a single pm2 process",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "StartPm2Process",
+ "group": "Pm2",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "script",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pm2/index.js",
+ "groupTitle": "Pm2"
+ },
+ {
+ "type": "put",
+ "url": "/api/pm2/{id}",
+ "title": "Update an existing process",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "UpdatePm2Process",
+ "group": "Pm2",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/pm2/index.js",
+ "groupTitle": "Pm2"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/campaigns/",
+ "title": "Gets a list of campaigns",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "Campaigns",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/fax/accounts",
+ "title": "Gets a list of FaxAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "FaxAccounts",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "put",
+ "url": "/api/rpc/agents/:id/capacity",
+ "title": "Sets agent capacity",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTAgentCapacity",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/agents",
+ "title": "Gets a list of RTAgents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTAgents",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/chat/queues",
+ "title": "Gets a list of RTChatQueues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTChatQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/fax/queues",
+ "title": "Gets a list of RTFaxQueues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTFaxQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/mail/accounts",
+ "title": "Gets a list of RTMailAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTMailAccounts",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/mail/queues",
+ "title": "Gets a list of RTMailQueues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTMailQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/openchannel/queues",
+ "title": "Gets a list of RTOpenchannelQueues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTOpenchannelQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/outbound/channels",
+ "title": "Gets a list of RTOutboundChannels",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTOutboundChannels",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/sms/queues",
+ "title": "Gets a list of RTSmsQueues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTSmsQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/telephones",
+ "title": "Gets a list of RTTelephones",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTTelephones",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/trunks",
+ "title": "Gets a list of RTTrunks",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTTrunks",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/channels",
+ "title": "Gets a list of RTVoiceChannelMixMonitor",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceChannelMixMonitor",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/channels",
+ "title": "Gets a list of RTVoiceChannelStopMixMonitor",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceChannelStopMixMonitor",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/channels",
+ "title": "Gets a list of RTVoiceChannels",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceChannels",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues/channels/{uniqueid}",
+ "title": "Gets a single RTVoiceQueueChannel",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueueChannel",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
+ "title": "Hangup a single RTVoiceQueueChannel",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueueChannelHangup",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
+ "title": "Hangup a single RTVoiceQueueChannel",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueueChannelRedirect",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues/preview/{id}",
+ "title": "Gets a single preview contact",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueuePreview",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/outbound",
+ "title": "Gets a list of RTOutbound",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues",
+ "title": "Gets a list of RTVoiceQueues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueues",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues/channels",
+ "title": "Gets a list of RTVoiceQueuesChannels",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RTVoiceQueuesChannels",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/chat/queues/{id}",
+ "title": "Gets a single RTChatQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRTChatQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/fax/queues/{id}",
+ "title": "Gets a single RTFaxQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRTFaxQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/mail/queues/{id}",
+ "title": "Gets a single RTMailQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRTMailQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/openchannel/queues/{id}",
+ "title": "Gets a single RTOpenchannelQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRTOpenchannelQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/sms/queues/{id}",
+ "title": "Gets a single RTSmsQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRTSmsQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/voice/queues/{id}",
+ "title": "Gets a single RTVoiceQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRTVoiceQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/rpc/agents/:id/notify",
+ "title": "Notify message to a specific agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "agentNotify",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/rpc/chat/queues/:id/notify",
+ "title": "Notify message to a specific queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "chatQueueNotify",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/chat/queues/waitinginteractions",
+ "title": "Gets a list of chatQueuesWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "chatQueuesWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/rpc/fax/queues/:id/notify",
+ "title": "Notify message to a specific queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "faxQueueNotify",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/fax/queues/waitinginteractions",
+ "title": "Gets a list of faxQueuesWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "faxQueuesWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/rpc/mail/queues/:id/notify",
+ "title": "Notify message to a specific queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "mailQueueNotify",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/mail/queues/waitinginteractions",
+ "title": "Gets a list of mailQueuesWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "mailQueuesWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/rpc/openchannel/queues/:id/notify",
+ "title": "Notify message to a specific queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "openchannelQueueNotify",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
+ "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "openchannelQueuesIdWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/openchannel/queues/waitinginteractions",
+ "title": "Gets a list of openchannelQueuesWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "openchannelQueuesWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/rpc/sms/queues/:id/notify",
+ "title": "Notify message to a specific queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "smsQueueNotify",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/rpc/sms/queues/waitinginteractions",
+ "title": "Gets a list of smsQueuesWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "smsQueuesWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "post",
+ "url": "/api/retention/cofigurations",
+ "title": "Creates a new RetentionConfiguration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/cofigurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateRetentionConfigurations",
+ "group": "Retention_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"voiceCalls\"",
+ "\"voiceRecordings\"",
+ "\"callySquare\"",
+ "\"motionBull\""
+ ],
+ "optional": true,
+ "field": "group",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "retentionPeriod",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "backupData",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "sendEmailReport",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "emailTo",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "emailCc",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionConfiguration/index.js",
+ "groupTitle": "Retention_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/retention/cofigurations/{id}",
+ "title": "Deletes a RetentionConfiguration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/cofigurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteRetentionConfigurations",
+ "group": "Retention_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionConfiguration/index.js",
+ "groupTitle": "Retention_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/retention/cofigurations",
+ "title": "Gets a list of RetentionConfigurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/cofigurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetRetentionConfigurations",
+ "group": "Retention_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/retention/cofigurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/retention/cofigurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/retention/cofigurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/retention/cofigurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/retention/cofigurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionConfiguration/index.js",
+ "groupTitle": "Retention_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/retention/cofigurations/{id}",
+ "title": "Gets a single RetentionConfiguration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/cofigurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRetentionConfigurations",
+ "group": "Retention_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionConfiguration/index.js",
+ "groupTitle": "Retention_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/retention/cofigurations/{id}",
+ "title": "Update an existing RetentionConfiguration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/cofigurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateRetentionConfigurations",
+ "group": "Retention_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionConfiguration/index.js",
+ "groupTitle": "Retention_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/retention/histories",
+ "title": "Creates a new RetentionHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/histories -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateRetentionHistories",
+ "group": "Retention_Histories",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "status",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionHistory/index.js",
+ "groupTitle": "Retention_Histories"
+ },
+ {
+ "type": "delete",
+ "url": "/api/retention/histories/{id}",
+ "title": "Deletes a RetentionHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/histories/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteRetentionHistories",
+ "group": "Retention_Histories",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionHistory/index.js",
+ "groupTitle": "Retention_Histories"
+ },
+ {
+ "type": "get",
+ "url": "/api/retention/histories",
+ "title": "Gets a list of RetentionHistories",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/histories -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetRetentionHistories",
+ "group": "Retention_Histories",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/retention/histories?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/retention/histories?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/retention/histories?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/retention/histories?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/retention/histories?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionHistory/index.js",
+ "groupTitle": "Retention_Histories"
+ },
+ {
+ "type": "get",
+ "url": "/api/retention/histories/{id}",
+ "title": "Gets a single RetentionHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/histories/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRetentionHistories",
+ "group": "Retention_Histories",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionHistory/index.js",
+ "groupTitle": "Retention_Histories"
+ },
+ {
+ "type": "put",
+ "url": "/api/retention/histories/{id}",
+ "title": "Update an existing RetentionHistory",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/retention/histories/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateRetentionHistories",
+ "group": "Retention_Histories",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/retentionHistory/index.js",
+ "groupTitle": "Retention_Histories"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/salesforce/accounts",
+ "title": "Creates a new Salesforce Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSalesforce_Accounts",
+ "group": "Salesforce_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clientId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clientSecret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "securityToken",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"integrationTab\"",
+ "\"newTab\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/salesforce/accounts/{id}",
+ "title": "Deletes a Salesforce Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSalesforce_Accounts",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/accounts",
+ "title": "Gets a list of Salesforce Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSalesforce_Accounts",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/accounts/{id}",
+ "title": "Gets a single Salesforce Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSalesforce_Accounts",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/salesforce/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/salesforce/accounts/{id}",
+ "title": "Update an existing Salesforce Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSalesforce_Accounts",
+ "group": "Salesforce_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceAccount/index.js",
+ "groupTitle": "Salesforce_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/salesforce/configurations",
+ "title": "Creates a new Salesforce Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSalesforce_Configurations",
+ "group": "Salesforce_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"Task\"",
+ "\"Case\""
+ ],
+ "optional": true,
+ "field": "ticketType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"contact_lead\"",
+ "\"contact\"",
+ "\"lead\""
+ ],
+ "optional": true,
+ "field": "moduleSearch",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"nothing\"",
+ "\"contact\"",
+ "\"lead\""
+ ],
+ "optional": true,
+ "field": "moduleCreate",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/salesforce/configurations/{id}",
+ "title": "Deletes a Salesforce Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSalesforce_Configurations",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/configurations",
+ "title": "Gets a list of Salesforce Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSalesforce_Configurations",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/configurations/{id}",
+ "title": "Gets a single Salesforce Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSalesforce_Configurations",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/salesforce/configurations/{id}",
+ "title": "Update an existing Salesforce Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSalesforce_Configurations",
+ "group": "Salesforce_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceConfiguration/index.js",
+ "groupTitle": "Salesforce_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/salesforce/fields",
+ "title": "Creates a new Salesforce Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSalesforce_Fields",
+ "group": "Salesforce_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceField/index.js",
+ "groupTitle": "Salesforce_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/salesforce/fields/{id}",
+ "title": "Deletes a Salesforce Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSalesforce_Fields",
+ "group": "Salesforce_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceField/index.js",
+ "groupTitle": "Salesforce_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/fields",
+ "title": "Gets a list of Salesforce Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSalesforce_Fields",
+ "group": "Salesforce_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceField/index.js",
+ "groupTitle": "Salesforce_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/salesforce/fields/{id}",
+ "title": "Gets a single Salesforce Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSalesforce_Fields",
+ "group": "Salesforce_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceField/index.js",
+ "groupTitle": "Salesforce_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/salesforce/fields/{id}",
+ "title": "Update an existing Salesforce Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSalesforce_Fields",
+ "group": "Salesforce_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSalesforceField/index.js",
+ "groupTitle": "Salesforce_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/schedules",
+ "title": "Creates a new Schedule",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSchedules",
+ "group": "Schedules",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": false,
+ "field": "active",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "cron",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "startAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "endAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "subtractNumber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"years\"",
+ "\"quarters\"",
+ "\"months\"",
+ "\"weeks\"",
+ "\"days\"",
+ "\"hours\"",
+ "\"minutes\""
+ ],
+ "optional": false,
+ "field": "subtractUnit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"csv\"",
+ "\"pdf\"",
+ "\"xlsx\""
+ ],
+ "optional": false,
+ "field": "output",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"custom\"",
+ "\"default\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "sendMail",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "email",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "cc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "bcc",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "sendIfEmpty",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/schedule/index.js",
+ "groupTitle": "Schedules"
+ },
+ {
+ "type": "delete",
+ "url": "/api/schedules/{id}",
+ "title": "Deletes a Schedule",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSchedules",
+ "group": "Schedules",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/schedule/index.js",
+ "groupTitle": "Schedules"
+ },
+ {
+ "type": "get",
+ "url": "/api/schedules",
+ "title": "Gets a list of Schedules",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSchedules",
+ "group": "Schedules",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/schedule/index.js",
+ "groupTitle": "Schedules"
+ },
+ {
+ "type": "get",
+ "url": "/api/schedules/{id}",
+ "title": "Gets a single Schedule",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSchedules",
+ "group": "Schedules",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/schedule/index.js",
+ "groupTitle": "Schedules"
+ },
+ {
+ "type": "get",
+ "url": "/api/schedules/{id}/run",
+ "title": "Run Scheduler",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "run",
+ "group": "Schedules",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/schedule/index.js",
+ "groupTitle": "Schedules"
+ },
+ {
+ "type": "put",
+ "url": "/api/schedules/{id}",
+ "title": "Update an existing Schedule",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateSchedules",
+ "group": "Schedules",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/schedule/index.js",
+ "groupTitle": "Schedules"
+ },
+ {
+ "type": "post",
+ "url": "/api/screen/recordings",
+ "title": "Creates a new Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateRecordings",
+ "group": "Screen_Recordings",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "format",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interactionid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "rating",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "duration",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "startedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "createdAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "updatedAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/screen/recordings/describe",
+ "title": "Gets table info about Recordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeRecordings",
+ "group": "Screen_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/screen/recordings",
+ "title": "Gets a list of Recordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetRecordings",
+ "group": "Screen_Recordings",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/screen/recordings/{id}",
+ "title": "Gets a single Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRecordings",
+ "group": "Screen_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "delete",
+ "url": "/api/screen/recordings/{id}",
+ "title": "Delete screen recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "destroy",
+ "group": "Screen_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/screen/recordings/{id}/download",
+ "title": "Download Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Screen_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "put",
+ "url": "/api/screen/recordings/{id}",
+ "title": "Update an existing Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateRecordings",
+ "group": "Screen_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/screenRecording/index.js",
+ "groupTitle": "Screen_Recordings"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/servicenow/accounts",
+ "title": "Creates a new Servicenow Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateServicenow_Accounts",
+ "group": "Servicenow_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "email",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/servicenow/accounts/{id}",
+ "title": "Deletes a Servicenow Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteServicenow_Accounts",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/accounts",
+ "title": "Gets a list of Servicenow Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetServicenow_Accounts",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/accounts/{id}",
+ "title": "Gets a single Servicenow Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowServicenow_Accounts",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/servicenow/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/servicenow/accounts/{id}",
+ "title": "Update an existing Servicenow Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateServicenow_Accounts",
+ "group": "Servicenow_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowAccount/index.js",
+ "groupTitle": "Servicenow_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/servicenow/configurations",
+ "title": "Creates a new Servicenow Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateServicenow_Configurations",
+ "group": "Servicenow_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/servicenow/configurations/{id}",
+ "title": "Deletes a Servicenow Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteServicenow_Configurations",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/configurations",
+ "title": "Gets a list of Servicenow Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetServicenow_Configurations",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/configurations/{id}",
+ "title": "Gets a single Servicenow Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowServicenow_Configurations",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/servicenow/configurations/{id}",
+ "title": "Update an existing Servicenow Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateServicenow_Configurations",
+ "group": "Servicenow_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowConfiguration/index.js",
+ "groupTitle": "Servicenow_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/servicenow/fields",
+ "title": "Creates a new Servicenow Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateServicenow_Fields",
+ "group": "Servicenow_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowField/index.js",
+ "groupTitle": "Servicenow_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/servicenow/fields/{id}",
+ "title": "Deletes a Servicenow Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteServicenow_Fields",
+ "group": "Servicenow_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowField/index.js",
+ "groupTitle": "Servicenow_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/fields",
+ "title": "Gets a list of Servicenow Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetServicenow_Fields",
+ "group": "Servicenow_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowField/index.js",
+ "groupTitle": "Servicenow_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/servicenow/fields/{id}",
+ "title": "Gets a single Servicenow Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowServicenow_Fields",
+ "group": "Servicenow_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowField/index.js",
+ "groupTitle": "Servicenow_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/servicenow/fields/{id}",
+ "title": "Update an existing Servicenow Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateServicenow_Fields",
+ "group": "Servicenow_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intServicenowField/index.js",
+ "groupTitle": "Servicenow_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings",
+ "title": "Gets a list of Settings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSettings",
+ "group": "Settings",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/{id}",
+ "title": "Gets a single Setting",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSettings",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "post",
+ "url": "/api/settings/{id}/favicon",
+ "title": "Add Favicon",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addFavicon",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "post",
+ "url": "/api/settings/{id}/logo",
+ "title": "Add logo",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addLogo",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "post",
+ "url": "/api/settings/{id}/logo_login",
+ "title": "Add logo login",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addLogoLogin",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "post",
+ "url": "/api/settings/{id}/preferred",
+ "title": "Add Preferred",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addPreferred",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/now",
+ "title": "Get Server Current Date",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/now -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDate",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/{id}/favicon",
+ "title": "Get Favicon",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFavicon",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/{id}/gdpr",
+ "title": "Get gdpr settings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getGdpr",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/{id}/logo",
+ "title": "Get logo",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getLogo",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/{id}/logo_login",
+ "title": "Get logo login",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getLogoLogin",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
+ "url": "/api/settings/{id}/preferred",
+ "title": "Get Preferred",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getPreferred",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "put",
+ "url": "/api/settings/{id}",
+ "title": "Update an existing Setting",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateSettings",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/users",
+ "title": "Add agents to a sms account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts",
+ "title": "Creates a new Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAccounts",
+ "group": "Sms_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "remote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"twilio\"",
+ "\"skebby\"",
+ "\"connectel\"",
+ "\"clicksend\"",
+ "\"plivo\"",
+ "\"clickatell\"",
+ "\"csc\"",
+ "\"infobip\"",
+ "\"intelepeer\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountSid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "authId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "authToken",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"SI\"",
+ "\"TI\"",
+ "\"GP\""
+ ],
+ "optional": true,
+ "field": "smsMethod",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "apiKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "senderString",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "deliveryReport",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notificationTemplate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationSound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationShake",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "queueTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "queueTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "agentTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "baseUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/accounts/{id}",
+ "title": "Deletes a Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAccounts",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAccounts",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts",
+ "title": "Gets a list of Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAccounts",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/users",
+ "title": "Gets agents from sms account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/accounts/{id}/users",
+ "title": "Removes agents from a sms account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/accounts/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/accounts/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}",
+ "title": "Gets a single Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAccounts",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Sms_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Sms_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Sms_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/applications",
+ "title": "Gets account applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/interactions",
+ "title": "Gets Sms Account interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getInteractions",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/notify",
+ "title": "Notify new message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "notify",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion 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>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/send",
+ "title": "Send new sms message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "sendSms",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/status",
+ "title": "Receive message status as get request",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "statusMessage",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/accounts/{id}/status",
+ "title": "Receive message status",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "statusMessage",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/messages/{id}/status",
+ "title": "Receive message status",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "statusMessage",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/accounts/{id}",
+ "title": "Update an existing Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAccounts",
+ "group": "Sms_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsAccount/index.js",
+ "groupTitle": "Sms_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/applications",
+ "title": "Creates a new Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateApplications",
+ "group": "Sms_Applications",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsApplication/index.js",
+ "groupTitle": "Sms_Applications"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Sms_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsApplication/index.js",
+ "groupTitle": "Sms_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/applications",
+ "title": "Gets a list of Applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetApplications",
+ "group": "Sms_Applications",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsApplication/index.js",
+ "groupTitle": "Sms_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Sms_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsApplication/index.js",
+ "groupTitle": "Sms_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Sms_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsApplication/index.js",
+ "groupTitle": "Sms_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Sms_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/interactions/{id}/messages",
+ "title": "Creates new messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Sms_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/interactions/{id}/download",
+ "title": "Gets interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Sms_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsInteraction/index.js",
+ "groupTitle": "Sms_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Sms_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Sms_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Sms_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Sms_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Sms_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Sms_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsMessage/index.js",
+ "groupTitle": "Sms_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/reports/queue",
+ "title": "Creates a new Sms Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSms_Queue_Reports",
+ "group": "Sms_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueueReport/index.js",
+ "groupTitle": "Sms_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/reports/queue/{id}",
+ "title": "Deletes a Sms Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSms_Queue_Reports",
+ "group": "Sms_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueueReport/index.js",
+ "groupTitle": "Sms_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/reports/queue/describe",
+ "title": "Gets table info about Sms Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeSms_Queue_Reports",
+ "group": "Sms_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueueReport/index.js",
+ "groupTitle": "Sms_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/reports/queue",
+ "title": "Gets a list of Sms Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSms_Queue_Reports",
+ "group": "Sms_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueueReport/index.js",
+ "groupTitle": "Sms_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/reports/queue/{id}",
+ "title": "Gets a single Sms Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSms_Queue_Reports",
+ "group": "Sms_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueueReport/index.js",
+ "groupTitle": "Sms_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/reports/queue/{id}",
+ "title": "Update an existing Sms Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSms_Queue_Reports",
+ "group": "Sms_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueueReport/index.js",
+ "groupTitle": "Sms_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Sms_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": true,
+ "field": "strategy",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Sms_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Sms_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/sms/reports/transfer",
+ "title": "Creates a new Sms Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSms_Transfer_Reports",
+ "group": "Sms_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsTransferReport/index.js",
+ "groupTitle": "Sms_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/reports/transfer/{id}",
+ "title": "Deletes a Sms Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSms_Transfer_Reports",
+ "group": "Sms_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsTransferReport/index.js",
+ "groupTitle": "Sms_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/reports/transfer/describe",
+ "title": "Gets table info about Sms Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeSms_Transfer_Reports",
+ "group": "Sms_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsTransferReport/index.js",
+ "groupTitle": "Sms_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/reports/transfer",
+ "title": "Gets a list of Sms Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSms_Transfer_Reports",
+ "group": "Sms_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsTransferReport/index.js",
+ "groupTitle": "Sms_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sms/reports/transfer/{id}",
+ "title": "Gets a single Sms Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSms_Transfer_Reports",
+ "group": "Sms_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsTransferReport/index.js",
+ "groupTitle": "Sms_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/sms/reports/transfer/{id}",
+ "title": "Update an existing Sms Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSms_Transfer_Reports",
+ "group": "Sms_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsTransferReport/index.js",
+ "groupTitle": "Sms_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/sounds",
+ "title": "Gets a list of Sounds",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSounds",
+ "group": "Sounds",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/sound/index.js",
+ "groupTitle": "Sounds"
+ },
+ {
+ "type": "get",
+ "url": "/api/sounds/{id}",
+ "title": "Gets a single Sound",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSounds",
+ "group": "Sounds",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/sound/index.js",
+ "groupTitle": "Sounds"
+ },
+ {
+ "type": "post",
+ "url": "/api/sounds",
+ "title": "Create a new sound",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addSound",
+ "group": "Sounds",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/sound/index.js",
+ "groupTitle": "Sounds"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sounds/{id}",
+ "title": "Deletes a sound",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "destroySound",
+ "group": "Sounds",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/sound/index.js",
+ "groupTitle": "Sounds"
+ },
+ {
+ "type": "get",
+ "url": "/api/sounds/{id}/download",
+ "title": "Download Sound",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Sounds",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/sound/index.js",
+ "groupTitle": "Sounds"
+ },
+ {
+ "type": "put",
+ "url": "/api/sounds",
+ "title": "Update an existing new sound",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateSound",
+ "group": "Sounds",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/sound/index.js",
+ "groupTitle": "Sounds"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/details/reports",
+ "title": "Creates a new Square Detail Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSquare_Detail_Reports",
+ "group": "Square_Details_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "node",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "application",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "data",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "project_name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callerid",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReportDetail/index.js",
+ "groupTitle": "Square_Details_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/details/reports/{id}",
+ "title": "Deletes a Square Detail Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSquare_Detail_Reports",
+ "group": "Square_Details_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReportDetail/index.js",
+ "groupTitle": "Square_Details_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/details/reports/describe",
+ "title": "Gets table info about Square Detail Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeSquare_Detail_Reports",
+ "group": "Square_Details_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReportDetail/index.js",
+ "groupTitle": "Square_Details_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/details/reports",
+ "title": "Gets a list of Square Detail Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSquare_Detail_Reports",
+ "group": "Square_Details_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReportDetail/index.js",
+ "groupTitle": "Square_Details_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/details/reports/{id}",
+ "title": "Gets a single Square Detail Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSquare_Detail_Reports",
+ "group": "Square_Details_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReportDetail/index.js",
+ "groupTitle": "Square_Details_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/square/details/reports/{id}",
+ "title": "Update an existing Square Detail Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSquare_Detail_Reports",
+ "group": "Square_Details_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReportDetail/index.js",
+ "groupTitle": "Square_Details_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Square_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareMessage/index.js",
+ "groupTitle": "Square_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Square_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareMessage/index.js",
+ "groupTitle": "Square_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Square_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareMessage/index.js",
+ "groupTitle": "Square_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Square_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareMessage/index.js",
+ "groupTitle": "Square_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/square/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Square_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareMessage/index.js",
+ "groupTitle": "Square_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/odbc",
+ "title": "Creates a new ODBC",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateODBCs",
+ "group": "Square_ODBC",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dsn",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareOdbc/index.js",
+ "groupTitle": "Square_ODBC"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/odbc/{id}",
+ "title": "Deletes a ODBC",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteODBCs",
+ "group": "Square_ODBC",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareOdbc/index.js",
+ "groupTitle": "Square_ODBC"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/odbc",
+ "title": "Gets a list of ODBCs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetODBCs",
+ "group": "Square_ODBC",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareOdbc/index.js",
+ "groupTitle": "Square_ODBC"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/odbc/{id}",
+ "title": "Gets a single ODBC",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowODBCs",
+ "group": "Square_ODBC",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareOdbc/index.js",
+ "groupTitle": "Square_ODBC"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/odbc/{id}/test",
+ "title": "Test Odbc",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "test",
+ "group": "Square_ODBC",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareOdbc/index.js",
+ "groupTitle": "Square_ODBC"
+ },
+ {
+ "type": "put",
+ "url": "/api/square/odbc/{id}",
+ "title": "Update an existing ODBC",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateODBCs",
+ "group": "Square_ODBC",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareOdbc/index.js",
+ "groupTitle": "Square_ODBC"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/projects",
+ "title": "Creates a new Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateProjects",
+ "group": "Square_Projects",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notes",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Blob",
+ "optional": true,
+ "field": "preproduction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Blob",
+ "optional": true,
+ "field": "production",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/projects/{id}",
+ "title": "Deletes a Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteProjects",
+ "group": "Square_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/projects",
+ "title": "Gets a list of Projects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetProjects",
+ "group": "Square_Projects",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/projects/{id}",
+ "title": "Gets a single Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowProjects",
+ "group": "Square_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/projects/{id}/users",
+ "title": "Adds user permissions to a Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addUsers",
+ "group": "Square_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/projects/{id}/users",
+ "title": "Gets users permissions from Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getUsers",
+ "group": "Square_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/projects/{id}/users",
+ "title": "Removes user permissions from a Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "removeUsers",
+ "group": "Square_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "put",
+ "url": "/api/square/projects/{id}",
+ "title": "Update an existing Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateProjects",
+ "group": "Square_Projects",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "groupTitle": "Square_Projects"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/recordings",
+ "title": "Creates a new Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateRecordings",
+ "group": "Square_Recordings",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callerid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "extension",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dnid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "projectName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "saveName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "filename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "savePath",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "format",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareRecording/index.js",
+ "groupTitle": "Square_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/recordings",
+ "title": "Gets a list of Recordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetRecordings",
+ "group": "Square_Recordings",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareRecording/index.js",
+ "groupTitle": "Square_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/recordings/{id}",
+ "title": "Gets a single Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRecordings",
+ "group": "Square_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareRecording/index.js",
+ "groupTitle": "Square_Recordings"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/recordings/{id}/delete",
+ "title": "Delete recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "destroy",
+ "group": "Square_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareRecording/index.js",
+ "groupTitle": "Square_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/recordings/{id}/download",
+ "title": "Download Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Square_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareRecording/index.js",
+ "groupTitle": "Square_Recordings"
+ },
+ {
+ "type": "put",
+ "url": "/api/square/recordings/{id}",
+ "title": "Update an existing Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateRecordings",
+ "group": "Square_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareRecording/index.js",
+ "groupTitle": "Square_Recordings"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/reports",
+ "title": "Creates a new Square Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSquare_Reports",
+ "group": "Square_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "network",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "network_script",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "request",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "language",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "version",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callerid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callingpres",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callingani2",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callington",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callingtns",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dnid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "rdnis",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "extension",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "enhanced",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "threadid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "project_name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "bot",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReport/index.js",
+ "groupTitle": "Square_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/reports/{id}",
+ "title": "Deletes a Square Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSquare_Reports",
+ "group": "Square_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReport/index.js",
+ "groupTitle": "Square_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/reports/describe",
+ "title": "Gets table info about Square Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeSquare_Reports",
+ "group": "Square_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReport/index.js",
+ "groupTitle": "Square_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/reports",
+ "title": "Gets a list of Square Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSquare_Reports",
+ "group": "Square_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReport/index.js",
+ "groupTitle": "Square_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/reports/{id}",
+ "title": "Gets a single Square Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSquare_Reports",
+ "group": "Square_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReport/index.js",
+ "groupTitle": "Square_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/square/reports/{id}",
+ "title": "Update an existing Square Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSquare_Reports",
+ "group": "Square_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/squareReport/index.js",
+ "groupTitle": "Square_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/sugarcrm/configurations",
+ "title": "Creates a new SugarCRM Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSugarCRM_Configurations",
+ "group": "SugarCRM_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "SugarCRM_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/sugarcrm/configurations/{id}",
+ "title": "Deletes a SugarCRM Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSugarCRM_Configurations",
+ "group": "SugarCRM_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "SugarCRM_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/configurations",
+ "title": "Gets a list of SugarCRM Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSugarCRM_Configurations",
+ "group": "SugarCRM_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "SugarCRM_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/configurations/{id}",
+ "title": "Gets a single SugarCRM Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSugarCRM_Configurations",
+ "group": "SugarCRM_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "SugarCRM_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/sugarcrm/configurations/{id}",
+ "title": "Update an existing SugarCRM Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSugarCRM_Configurations",
+ "group": "SugarCRM_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "SugarCRM_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/sugarcrm/accounts",
+ "title": "Creates a new Sugarcrm Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSugarcrm_Accounts",
+ "group": "Sugarcrm_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/sugarcrm/accounts/{id}",
+ "title": "Deletes a Sugarcrm Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSugarcrm_Accounts",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/accounts",
+ "title": "Gets a list of Sugarcrm Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSugarcrm_Accounts",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/accounts/{id}",
+ "title": "Gets a single Sugarcrm Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSugarcrm_Accounts",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/sugarcrm/accounts/{id}",
+ "title": "Update an existing Sugarcrm Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSugarcrm_Accounts",
+ "group": "Sugarcrm_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmAccount/index.js",
+ "groupTitle": "Sugarcrm_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Sugarcrm_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "Sugarcrm_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Sugarcrm_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "Sugarcrm_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Sugarcrm_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmConfiguration/index.js",
+ "groupTitle": "Sugarcrm_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/sugarcrm/fields",
+ "title": "Creates a new Sugarcrm Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateSugarcrm_Fields",
+ "group": "Sugarcrm_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmField/index.js",
+ "groupTitle": "Sugarcrm_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/sugarcrm/fields/{id}",
+ "title": "Deletes a Sugarcrm Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteSugarcrm_Fields",
+ "group": "Sugarcrm_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmField/index.js",
+ "groupTitle": "Sugarcrm_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/fields",
+ "title": "Gets a list of Sugarcrm Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSugarcrm_Fields",
+ "group": "Sugarcrm_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmField/index.js",
+ "groupTitle": "Sugarcrm_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/sugarcrm/fields/{id}",
+ "title": "Gets a single Sugarcrm Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowSugarcrm_Fields",
+ "group": "Sugarcrm_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmField/index.js",
+ "groupTitle": "Sugarcrm_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/sugarcrm/fields/{id}",
+ "title": "Update an existing Sugarcrm Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateSugarcrm_Fields",
+ "group": "Sugarcrm_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intSugarcrmField/index.js",
+ "groupTitle": "Sugarcrm_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/system",
+ "title": "Gets system information",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/system -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSystemInformation",
+ "group": "System_Information",
+ "description": "<p>Motion returns the system information.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/system/index.js",
+ "groupTitle": "System_Information"
+ },
+ {
+ "type": "get",
+ "url": "/api/system/process",
+ "title": "Gets system information",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/system -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetSystemInformation",
+ "group": "System_Information",
+ "description": "<p>Motion returns the system information.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/system/index.js",
+ "groupTitle": "System_Information"
+ },
+ {
+ "type": "post",
+ "url": "/api/tags",
+ "title": "Creates a new Tag",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateTags",
+ "group": "Tags",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "color",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/tag/index.js",
+ "groupTitle": "Tags"
+ },
+ {
+ "type": "delete",
+ "url": "/api/tags/{id}",
+ "title": "Deletes a Tag",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteTags",
+ "group": "Tags",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/tag/index.js",
+ "groupTitle": "Tags"
+ },
+ {
+ "type": "get",
+ "url": "/api/tags",
+ "title": "Gets a list of Tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTags",
+ "group": "Tags",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/tag/index.js",
+ "groupTitle": "Tags"
+ },
+ {
+ "type": "get",
+ "url": "/api/tags/{id}",
+ "title": "Gets a single Tag",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowTags",
+ "group": "Tags",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/tag/index.js",
+ "groupTitle": "Tags"
+ },
+ {
+ "type": "put",
+ "url": "/api/tags/{id}",
+ "title": "Update an existing Tag",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateTags",
+ "group": "Tags",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/tag/index.js",
+ "groupTitle": "Tags"
+ },
+ {
+ "type": "post",
+ "url": "/api/teams/{id}/queues",
+ "title": "Add queues to a team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddQueues",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "post",
+ "url": "/api/teams",
+ "title": "Creates a new Team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateTeams",
+ "group": "Teams",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/teams/{id}",
+ "title": "Deletes a Team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "get",
+ "url": "/api/teams/{id}/users",
+ "title": "Gets agents from team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "get",
+ "url": "/api/teams/{id}/queues?channel={channel}",
+ "title": "Gets Queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "get",
+ "url": "/api/teams",
+ "title": "Gets a list of Teams",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Teams",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/teams/{id}/users",
+ "title": "Removes agents from a team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/teams/{id}/queues",
+ "title": "Remove queues to a team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveQueues",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/openchannel/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/openchannelQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/sms/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/chat/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/mail/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "get",
+ "url": "/api/teams/{id}",
+ "title": "Gets a single Team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "post",
+ "url": "/api/teams/{id}/users",
+ "title": "Adds agents to a team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addAgents",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "put",
+ "url": "/api/teams/{id}",
+ "title": "Update an existing Team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/team/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "post",
+ "url": "/api/templates",
+ "title": "Creates a new Template",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateTemplates",
+ "group": "Templates",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "html",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/template/index.js",
+ "groupTitle": "Templates"
+ },
+ {
+ "type": "delete",
+ "url": "/api/templates/{id}",
+ "title": "Deletes a Template",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteTemplates",
+ "group": "Templates",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/template/index.js",
+ "groupTitle": "Templates"
+ },
+ {
+ "type": "get",
+ "url": "/api/templates",
+ "title": "Gets a list of Templates",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTemplates",
+ "group": "Templates",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/template/index.js",
+ "groupTitle": "Templates"
+ },
+ {
+ "type": "get",
+ "url": "/api/templates/{id}",
+ "title": "Gets a single Template",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowTemplates",
+ "group": "Templates",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/template/index.js",
+ "groupTitle": "Templates"
+ },
+ {
+ "type": "put",
+ "url": "/api/templates/{id}",
+ "title": "Update an existing Template",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateTemplates",
+ "group": "Templates",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/template/index.js",
+ "groupTitle": "Templates"
+ },
+ {
+ "type": "post",
+ "url": "/api/triggers",
+ "title": "Creates a new Trigger",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateTriggers",
+ "group": "Triggers",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "status",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "delete",
+ "url": "/api/triggers/{id}",
+ "title": "Deletes a Trigger",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteTriggers",
+ "group": "Triggers",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "get",
+ "url": "/api/triggers",
+ "title": "Gets a list of Triggers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTriggers",
+ "group": "Triggers",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "get",
+ "url": "/api/triggers/{id}",
+ "title": "Gets a single Trigger",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowTriggers",
+ "group": "Triggers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "post",
+ "url": "/api/triggers/{id}/actions",
+ "title": "Creates new actions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addAction",
+ "group": "Triggers",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "action",
+ "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data1",
+ "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data2",
+ "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data3",
+ "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data4",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data5",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data6",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "data7",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "post",
+ "url": "/api/triggers/{id}/all_conditions",
+ "title": "Creates a new \"AND\"condition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAllCondition",
+ "group": "Triggers",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "field",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "operator",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "post",
+ "url": "/api/triggers/{id}/any_conditions",
+ "title": "Creates a new \"OR\"condition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnyCondition",
+ "group": "Triggers",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "field",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "operator",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "get",
+ "url": "/api/triggers/{id}/actions",
+ "title": "Gets Trigger Actions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getActions",
+ "group": "Triggers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "get",
+ "url": "/api/triggers/{id}/all_conditions",
+ "title": "Gets \"AND\" Trigger Conditions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAllConditions",
+ "group": "Triggers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "get",
+ "url": "/api/triggers/{id}/any_conditions",
+ "title": "Gets \"OR\" Trigger Conditions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnyConditions",
+ "group": "Triggers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "put",
+ "url": "/api/triggers/{id}",
+ "title": "Update an existing Trigger",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateTriggers",
+ "group": "Triggers",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trigger/index.js",
+ "groupTitle": "Triggers"
+ },
+ {
+ "type": "post",
+ "url": "/api/trunks/clone",
+ "title": "Clone an existing Trunk",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CloneTrunks",
+ "group": "Trunks",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trunk/index.js",
+ "groupTitle": "Trunks"
+ },
+ {
+ "type": "post",
+ "url": "/api/trunks",
+ "title": "Create a new trunk",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Create",
+ "group": "Trunks",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"friend\"",
+ "\"user\"",
+ "\"peer\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"ALLOWED_NOT_SCREENED\"",
+ "\"ALLOWED_PASSED_SCREEN\"",
+ "\"ALLOWED_FAILED_SCREEN\"",
+ "\"ALLOWED\"",
+ "\"PROHIB_NOT_SCREENED\"",
+ "\"PROHIB_PASSED_SCREEN\"",
+ "\"PROHIB_FAILED_SCREEN\"",
+ "\"PROHIB\""
+ ],
+ "optional": true,
+ "field": "callingpres",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "deny",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "permit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "md5secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remotesecret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transport",
+ "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rfc2833\"",
+ "\"info\"",
+ "\"shortinfo\"",
+ "\"inband\"",
+ "\"auto\""
+ ],
+ "optional": true,
+ "field": "dtmfmode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"nonat\"",
+ "\"update\"",
+ "\"outgoing\""
+ ],
+ "optional": true,
+ "field": "directmedia",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "directrtpsetup",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "directmediapermit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "directmediadeny",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nat",
+ "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callgroup",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "namedcallgroup",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "pickupgroup",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "namedpickupgroup",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "language",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "tonezone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disallow",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "allow",
+ "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "autoframing",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "insecure",
+ "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "trustrpid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "trust_id_outbound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"never\""
+ ],
+ "optional": true,
+ "field": "progressinband",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "promiscredir",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "useclientcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "accountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "setvar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callerid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "amaflags",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "callcounter",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "busylevel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "allowoverlap",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "allowsubscribe",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "allowtransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "ignoresdpversion",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "subscribecontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "template",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"always\""
+ ],
+ "optional": true,
+ "field": "videosupport",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "maxcallbitrate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "rfc2833compensate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mailbox",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"accept\"",
+ "\"refuse\"",
+ "\"originate\""
+ ],
+ "optional": true,
+ "field": "session_timers",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "session_expires",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "session_minse",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"uac\"",
+ "\"uas\""
+ ],
+ "optional": true,
+ "field": "session_refresher",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "t38pt_usertpsource",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "regexten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fromdomain",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fromuser",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "port",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "qualify",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "keepalive",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "defaultip",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "defaultuser",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "rtptimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "rtpholdtimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "rtpkeepalive",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"pai\""
+ ],
+ "optional": true,
+ "field": "sendrpid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "outboundproxy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callbackextension",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timert1",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timerb",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "qualifyfreq",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "contactpermit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "contactdeny",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "contactacl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "unsolicited_mailbox",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "use_q850_reason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "maxforwards",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "encryption",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "avpf",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "force_avp",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "icesupport",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "dtlsenable",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"fingerprint\"",
+ "\"certificate\""
+ ],
+ "optional": true,
+ "field": "dtlsverify",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dtlsrekey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dtlscertfile",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dtlsprivatekey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dtlscipher",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dtlscafile",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dtlscapath",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"active\"",
+ "\"passive\"",
+ "\"actpass\""
+ ],
+ "optional": true,
+ "field": "dtlssetup",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dtlsfingerprint",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "usereqphone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "recordonfeature",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "recordofffeature",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "call_limit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "registertrying",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "subscribemwi",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "vmexten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mohinterpret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mohsuggest",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "parkinglot",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "host",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"nonat\"",
+ "\"update\"",
+ "\"update,nonat\""
+ ],
+ "optional": true,
+ "field": "canreinvite",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "registry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "otherFields",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": false,
+ "field": "active",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "t38pt_udptl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trunk/index.js",
+ "groupTitle": "Trunks"
+ },
+ {
+ "type": "delete",
+ "url": "/api/trunks/{id}",
+ "title": "Deletes a trunk",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "Delete",
+ "group": "Trunks",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trunk/index.js",
+ "groupTitle": "Trunks"
+ },
+ {
+ "type": "get",
+ "url": "/api/trunks",
+ "title": "Gets a list of Trunks",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTrunks",
+ "group": "Trunks",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/trunk/index.js",
+ "groupTitle": "Trunks"
+ },
+ {
+ "type": "get",
+ "url": "/api/trunks/{id}",
+ "title": "Gets a single Trunk",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowTrunks",
+ "group": "Trunks",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trunk/index.js",
+ "groupTitle": "Trunks"
+ },
+ {
+ "type": "put",
+ "url": "/api/trunks/{id}",
+ "title": "Update an existing trunk",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "Update",
+ "group": "Trunks",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/trunk/index.js",
+ "groupTitle": "Trunks"
+ },
+ {
+ "type": "post",
+ "url": "/api/userProfile/resources",
+ "title": "Creates a new User Profile Resource",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateUser_Profile_Resources",
+ "group": "User_Profile_Resources",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "resourceId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "type",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileResource/index.js",
+ "groupTitle": "User_Profile_Resources"
+ },
+ {
+ "type": "delete",
+ "url": "/api/userProfile/resources/{id}",
+ "title": "Deletes a User Profile Resource",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteUser_Profile_Resources",
+ "group": "User_Profile_Resources",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileResource/index.js",
+ "groupTitle": "User_Profile_Resources"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfile/resources/describe",
+ "title": "Gets table info about User Profile Resources",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeUser_Profile_Resources",
+ "group": "User_Profile_Resources",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileResource/index.js",
+ "groupTitle": "User_Profile_Resources"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfile/resources",
+ "title": "Gets a list of User Profile Resources",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetUser_Profile_Resources",
+ "group": "User_Profile_Resources",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileResource/index.js",
+ "groupTitle": "User_Profile_Resources"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfile/resources/{id}",
+ "title": "Gets a single User Profile Resource",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowUser_Profile_Resources",
+ "group": "User_Profile_Resources",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileResource/index.js",
+ "groupTitle": "User_Profile_Resources"
+ },
+ {
+ "type": "put",
+ "url": "/api/userProfile/resources/{id}",
+ "title": "Update an existing User Profile Resource",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateUser_Profile_Resources",
+ "group": "User_Profile_Resources",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileResource/index.js",
+ "groupTitle": "User_Profile_Resources"
+ },
+ {
+ "type": "post",
+ "url": "/api/userProfile/sections",
+ "title": "Creates a new User Profile Section",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateUser_Profile_Sections",
+ "group": "User_Profile_Sections",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "category",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "sectionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "enabled",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoAssociation",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "crudPermissions",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileSection/index.js",
+ "groupTitle": "User_Profile_Sections"
+ },
+ {
+ "type": "delete",
+ "url": "/api/userProfile/sections/{id}",
+ "title": "Deletes a User Profile Section",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteUser_Profile_Sections",
+ "group": "User_Profile_Sections",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileSection/index.js",
+ "groupTitle": "User_Profile_Sections"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfile/sections/describe",
+ "title": "Gets table info about User Profile Sections",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeUser_Profile_Sections",
+ "group": "User_Profile_Sections",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileSection/index.js",
+ "groupTitle": "User_Profile_Sections"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfile/sections",
+ "title": "Gets a list of User Profile Sections",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetUser_Profile_Sections",
+ "group": "User_Profile_Sections",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileSection/index.js",
+ "groupTitle": "User_Profile_Sections"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfile/sections/{id}",
+ "title": "Gets a single User Profile Section",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowUser_Profile_Sections",
+ "group": "User_Profile_Sections",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileSection/index.js",
+ "groupTitle": "User_Profile_Sections"
+ },
+ {
+ "type": "put",
+ "url": "/api/userProfile/sections/{id}",
+ "title": "Update an existing User Profile Section",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateUser_Profile_Sections",
+ "group": "User_Profile_Sections",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfileSection/index.js",
+ "groupTitle": "User_Profile_Sections"
+ },
+ {
+ "type": "post",
+ "url": "/api/userProfiles/{id}/resources",
+ "title": "Add resources' permissions to User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddResources",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "post",
+ "url": "/api/userProfiles/{id}/sections",
+ "title": "Add sections' permissions to User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddSections",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "post",
+ "url": "/api/userProfiles/clone",
+ "title": "Clone an existing User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CloneUser_Profiles",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "post",
+ "url": "/api/userProfiles",
+ "title": "Creates a new User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateUser_Profiles",
+ "group": "User_Profiles",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "crudPermissions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "delete",
+ "url": "/api/userProfiles/{id}",
+ "title": "Deletes a User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteUser_Profiles",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfiles/describe",
+ "title": "Gets table info about User Profiles",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeUser_Profiles",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfiles/{id}/resources?section={section}",
+ "title": "Get Resources assigned to a Section",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetResources",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfiles/{id}/sections",
+ "title": "Get sections associated to a User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetSections",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfiles",
+ "title": "Gets a list of User Profiles",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetUser_Profiles",
+ "group": "User_Profiles",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "delete",
+ "url": "/api/userProfiles/{id}/resources",
+ "title": "Removes resources' permissions from User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveResources",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "delete",
+ "url": "/api/userProfiles/{id}/sections",
+ "title": "Removes sections' permissions from User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveSections",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "get",
+ "url": "/api/userProfiles/{id}",
+ "title": "Gets a single User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowUser_Profiles",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "put",
+ "url": "/api/userProfiles/{id}",
+ "title": "Update an existing User Profile",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateUser_Profiles",
+ "group": "User_Profiles",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userProfile/index.js",
+ "groupTitle": "User_Profiles"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/chat_interactions",
+ "title": "Add chat interaction tabs to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddChatInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/chat_websites",
+ "title": "Add a Chat Website to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddChatWebsites",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/contacts",
+ "title": "Add contacts to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddContacts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/fax_accounts",
+ "title": "Add a Fax Account to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddFaxAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/fax_interactions",
+ "title": "Add fax interaction tabs to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddFaxInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/mail_accounts",
+ "title": "Add a Mail Account to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddMailAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/mail_interactions",
+ "title": "Add mail interaction tabs to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddMailInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/openchannel_accounts",
+ "title": "Add a Open Channel Account to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddOpenchannelAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/openchannel_interactions",
+ "title": "Add openchannel interaction tabs to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddOpenchannelInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/queues",
+ "title": "Add queues to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddQueues",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/sms_accounts",
+ "title": "Add a Sms Account to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddSmsAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/sms_interactions",
+ "title": "Add sms interaction tabs to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddSmsInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/square_projects",
+ "title": "Add a Square Project to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddSquareProjects",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/teams",
+ "title": "Add teams to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/whatsapp_accounts",
+ "title": "Add a Whatsapp Account to a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddWhatsappAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/whatsapp_interactions",
+ "title": "Add Whatsapp interaction tabs to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddWhatsappInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "put",
+ "url": "/api/users/{id}/password",
+ "title": "Change user password",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "ChangePwd",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users",
+ "title": "Create a new user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Create",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/api_key",
+ "title": "Create a new API access key for the user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateApiKey",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}",
+ "title": "Deletes a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "Delete",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/describe",
+ "title": "Gets table info about Users",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeUsers",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/agents",
+ "title": "GetAgents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/api_key",
+ "title": "Get the API access key for the user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetApiKey",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/groups",
+ "title": "GetChatGroups",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetChatGroups",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/chat/interactions",
+ "title": "GetChatInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetChatInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/chat_websites",
+ "title": "GetChatWebsites",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetChatWebsites",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/contacts",
+ "title": "GetContacts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetContacts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/fax_accounts",
+ "title": "GetFaxAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetFaxAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/fax/interactions",
+ "title": "GetFaxInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetFaxInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/lists",
+ "title": "GetLists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetLists",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/mail_accounts",
+ "title": "GetMailAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetMailAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/mail/interactions",
+ "title": "GetMailInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetMailInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/openchannel_accounts",
+ "title": "GetOpenchannelAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetOpenchannelAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/openchannel/interactions",
+ "title": "GetOpenchannelInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetOpenchannelInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/prefixes",
+ "title": "GetPrefixes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetPrefixes",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/queues?channel={channel}",
+ "title": "Gets Queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/recordings",
+ "title": "GetRecordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetRecordings",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/scheduled_calls",
+ "title": "GetScheduledCalls",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetScheduledCalls",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/screen_recordings",
+ "title": "GetScreenRecordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetScreenRecordings",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/sms_accounts",
+ "title": "GetSmsAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetSmsAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/sms/interactions",
+ "title": "GetSmsInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetSmsInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/square_projects",
+ "title": "GetSquareProjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetSquareProjects",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/teams",
+ "title": "GetTeams",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users",
+ "title": "Gets a list of Users",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetUsers",
+ "group": "Users",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/queues_rt",
+ "title": "GetVoiceQueuesRt",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetVoiceQueuesRt",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/whatsapp_accounts",
+ "title": "GetWhatsappAccounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetWhatsappAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/whatsapp/interactions",
+ "title": "GetWhatsappInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetWhatsappInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/login",
+ "title": "Login",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Login",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/logout",
+ "title": "Logout",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Logout",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/pause",
+ "title": "Pause",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Pause",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/api_key",
+ "title": "Remove API access key for the user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveApiKey",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/chat_interactions",
+ "title": "Removes interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveChatInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/chat_websites",
+ "title": "Removes a Chat Website from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveChatWebsites",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/fax_accounts",
+ "title": "Removes a Fax Account from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveFaxAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/fax_interactions",
+ "title": "Removes interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveFaxInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/mail_accounts",
+ "title": "Removes a Mail Account from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveMailAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/mail_interactions",
+ "title": "Removes interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveMailInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/openchannel_accounts",
+ "title": "Removes a Open Channel Account from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveOpenchannelAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/openchannel_interactions",
+ "title": "Removes openchannel interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveOpenchannelInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/queues",
+ "title": "Remove queues to an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveQueues",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/sms_accounts",
+ "title": "Removes a Sms Account from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveSmsAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/sms_interactions",
+ "title": "Removes interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveSmsInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/square_projects",
+ "title": "Removes a Square Project from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveSquareProjects",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/teams",
+ "title": "Removes teams from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/whatsapp_accounts",
+ "title": "Removes a Whatsapp Account from a user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveWhatsappAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/whatsapp_interactions",
+ "title": "Removes Whatsapp interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveWhatsappInteractions",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}",
+ "title": "Gets a single User",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowUsers",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/unpause",
+ "title": "Unpause",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Unpause",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/whoami",
+ "title": "WhoAmI",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "WhoAmI",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/avatar",
+ "title": "Add avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addAvatar",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/create_many",
+ "title": "Create Users",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "bulkCreate",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/avatar",
+ "title": "Get avatar",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAvatar",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "put",
+ "url": "/api/users/{id}",
+ "title": "Update an existing User",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateUsers",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/variables",
+ "title": "Creates a new Variable",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateVariables",
+ "group": "Variables",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/variable/index.js",
+ "groupTitle": "Variables"
+ },
+ {
+ "type": "delete",
+ "url": "/api/variables/{id}",
+ "title": "Deletes a Variable",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteVariables",
+ "group": "Variables",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/variable/index.js",
+ "groupTitle": "Variables"
+ },
+ {
+ "type": "get",
+ "url": "/api/variables",
+ "title": "Gets a list of Variables",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetVariables",
+ "group": "Variables",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/variable/index.js",
+ "groupTitle": "Variables"
+ },
+ {
+ "type": "get",
+ "url": "/api/variables/{id}",
+ "title": "Gets a single Variable",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowVariables",
+ "group": "Variables",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/variable/index.js",
+ "groupTitle": "Variables"
+ },
+ {
+ "type": "put",
+ "url": "/api/variables/{id}",
+ "title": "Update an existing Variable",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateVariables",
+ "group": "Variables",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/variable/index.js",
+ "groupTitle": "Variables"
+ },
+ {
+ "type": "get",
+ "url": "/api/version/fetch",
+ "title": "Fetch git version",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "FetchVersion",
+ "group": "Version",
+ "description": "<p>Motion run the following command: git fetch origin master</p>",
+ "version": "0.0.0",
+ "filename": "server/api/version/index.js",
+ "groupTitle": "Version"
+ },
+ {
+ "type": "get",
+ "url": "/api/version",
+ "title": "Gets version",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/version -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetVersion",
+ "group": "Version",
+ "description": "<p>Motion returns the current and latest motion version.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/version/index.js",
+ "groupTitle": "Version"
+ },
+ {
+ "type": "get",
+ "url": "/api/version/migrations",
+ "title": "Launch database migrations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "MigrateVersion",
+ "group": "Version",
+ "description": "<p>Motion launch the database migrations, according to the application version</p>",
+ "version": "0.0.0",
+ "filename": "server/api/version/index.js",
+ "groupTitle": "Version"
+ },
+ {
+ "type": "get",
+ "url": "/api/version/pull",
+ "title": "Pull git version",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "PullVersion",
+ "group": "Version",
+ "description": "<p>Motion run the following command: git pull</p>",
+ "version": "0.0.0",
+ "filename": "server/api/version/index.js",
+ "groupTitle": "Version"
+ },
+ {
+ "type": "get",
+ "url": "/api/version/reset",
+ "title": "Reset git version",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ResetVersion",
+ "group": "Version",
+ "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
+ "version": "0.0.0",
+ "filename": "server/api/version/index.js",
+ "groupTitle": "Version"
+ },
+ {
+ "type": "get",
+ "url": "/api/version/restart",
+ "title": "Restart motion2 after update",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "RestartVersion",
+ "group": "Version",
+ "description": "<p>Motion run the following command: pm2 restart motion</p>",
+ "version": "0.0.0",
+ "filename": "server/api/version/index.js",
+ "groupTitle": "Version"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/agents/reports/describe",
+ "title": "Gets table info about Agent Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAgent_Reports",
+ "group": "Voice_Agent_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceAgentReport/index.js",
+ "groupTitle": "Voice_Agent_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/agents/reports",
+ "title": "Gets a list of Agent Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgent_Reports",
+ "group": "Voice_Agent_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceAgentReport/index.js",
+ "groupTitle": "Voice_Agent_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/agents/reports/{id}",
+ "title": "Gets a single Agent Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAgent_Reports",
+ "group": "Voice_Agent_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceAgentReport/index.js",
+ "groupTitle": "Voice_Agent_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/calls/reports/describe",
+ "title": "Gets table info about Call Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeCall_Reports",
+ "group": "Voice_Call_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceCallReport/index.js",
+ "groupTitle": "Voice_Call_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/calls/reports",
+ "title": "Gets a list of Call Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCall_Reports",
+ "group": "Voice_Call_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceCallReport/index.js",
+ "groupTitle": "Voice_Call_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/calls/reports/{id}",
+ "title": "Gets a single Call Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCall_Reports",
+ "group": "Voice_Call_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceCallReport/index.js",
+ "groupTitle": "Voice_Call_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/calls/reports/{id}",
+ "title": "Update a single cdr",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "Voice_Call_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceCallReport/index.js",
+ "groupTitle": "Voice_Call_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/chanspy",
+ "title": "Creates a new ChanSpy",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateChanSpy",
+ "group": "Voice_ChanSpy",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "prefix",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "options",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "auth",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "record",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "recordingFormat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceChanSpy/index.js",
+ "groupTitle": "Voice_ChanSpy"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/chanspy/{id}",
+ "title": "Deletes a ChanSpy",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteChanSpy",
+ "group": "Voice_ChanSpy",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceChanSpy/index.js",
+ "groupTitle": "Voice_ChanSpy"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/chanspy",
+ "title": "Gets a list of ChanSpy",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetChanSpy",
+ "group": "Voice_ChanSpy",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceChanSpy/index.js",
+ "groupTitle": "Voice_ChanSpy"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/chanspy/{id}",
+ "title": "Gets a single ChanSpy",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowChanSpy",
+ "group": "Voice_ChanSpy",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceChanSpy/index.js",
+ "groupTitle": "Voice_ChanSpy"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/chanspy/{id}",
+ "title": "Update an existing ChanSpy",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateChanSpy",
+ "group": "Voice_ChanSpy",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceChanSpy/index.js",
+ "groupTitle": "Voice_ChanSpy"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/contexts",
+ "title": "Create a new context",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Create",
+ "group": "Voice_Contexts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "defaultEntry",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceContext/index.js",
+ "groupTitle": "Voice_Contexts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/contexts/{id}",
+ "title": "Deletes a context",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "Delete",
+ "group": "Voice_Contexts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceContext/index.js",
+ "groupTitle": "Voice_Contexts"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/contexts",
+ "title": "Gets a list of Contexts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetContexts",
+ "group": "Voice_Contexts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceContext/index.js",
+ "groupTitle": "Voice_Contexts"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/contexts/{id}",
+ "title": "Gets a single Context",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowContexts",
+ "group": "Voice_Contexts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceContext/index.js",
+ "groupTitle": "Voice_Contexts"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/contexts/{id}",
+ "title": "Update an existing context",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "Update",
+ "group": "Voice_Contexts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceContext/index.js",
+ "groupTitle": "Voice_Contexts"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/dials/reports/describe",
+ "title": "Gets table info about Dial Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeDial_Reports",
+ "group": "Voice_Dial_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceDialReport/index.js",
+ "groupTitle": "Voice_Dial_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/dials/reports",
+ "title": "Gets a list of Dial Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetDial_Reports",
+ "group": "Voice_Dial_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceDialReport/index.js",
+ "groupTitle": "Voice_Dial_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/dials/reports/{id}",
+ "title": "Gets a single Dial Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowDial_Reports",
+ "group": "Voice_Dial_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceDialReport/index.js",
+ "groupTitle": "Voice_Dial_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/extensions/{id}",
+ "title": "Deletes a Extension",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteExtensions",
+ "group": "Voice_Extensions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceExtension/index.js",
+ "groupTitle": "Voice_Extensions"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/extensions",
+ "title": "Gets a list of Extensions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetExtensions",
+ "group": "Voice_Extensions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceExtension/index.js",
+ "groupTitle": "Voice_Extensions"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/extensions/{id}",
+ "title": "Gets a single Extension",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowExtensions",
+ "group": "Voice_Extensions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceExtension/index.js",
+ "groupTitle": "Voice_Extensions"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/extensions",
+ "title": "Create new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Voice_Extensions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceExtension/index.js",
+ "groupTitle": "Voice_Extensions"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/extensions",
+ "title": "Create an extension",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "create",
+ "group": "Voice_Extensions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceExtension/index.js",
+ "groupTitle": "Voice_Extensions"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/extensions/{id}",
+ "title": "Update an extension",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "Voice_Extensions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceExtension/index.js",
+ "groupTitle": "Voice_Extensions"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/mohs",
+ "title": "Create a new a new MOH",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddMoh",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/mohs/{id}/sounds",
+ "title": "Add sound to MOH",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddSound",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/mohs/{id}",
+ "title": "Deletes an MOH",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DestroyMoh",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mohs",
+ "title": "Gets a list of Music On Holds",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMusic_On_Holds",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mohs/{id}/sounds",
+ "title": "Gets sounds from MOH",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "GetSounds",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/mohs/{id}/sounds/{id2}",
+ "title": "Remove sound from MOH",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveSound",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mohs/{id}",
+ "title": "Gets a single Music On Hold",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMusic_On_Holds",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/mohs/{id}",
+ "title": "Update an existing Music On Hold",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMusic_On_Holds",
+ "group": "Voice_MOHs",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMusicOnHold/index.js",
+ "groupTitle": "Voice_MOHs"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/mails",
+ "title": "Creates a new Mail",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMails",
+ "group": "Voice_Mails",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "customer_id",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "mailbox",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "fullname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "email",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "pager",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "tz",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "attach",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "saycid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callback",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "review",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "operator",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "envelope",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "sayduration",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "saydurationm",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "sendvoicemail",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "delete",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "nextaftercmd",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "forcename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "forcegreetings",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": false,
+ "field": "hidefromdir",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "stamp",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "emailsubject",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "emailbody",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "maxsecs",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "maxmsg",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMail/index.js",
+ "groupTitle": "Voice_Mails"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/mails/{id}",
+ "title": "Deletes a Mail",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMails",
+ "group": "Voice_Mails",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMail/index.js",
+ "groupTitle": "Voice_Mails"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mails",
+ "title": "Gets a list of Mails",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMails",
+ "group": "Voice_Mails",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMail/index.js",
+ "groupTitle": "Voice_Mails"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mails/{id}",
+ "title": "Gets a single Mail",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMails",
+ "group": "Voice_Mails",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMail/index.js",
+ "groupTitle": "Voice_Mails"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mails/{id}/messages",
+ "title": "Gets voice mail messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Voice_Mails",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMail/index.js",
+ "groupTitle": "Voice_Mails"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/mails/{id}",
+ "title": "Update an existing Mail",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMails",
+ "group": "Voice_Mails",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMail/index.js",
+ "groupTitle": "Voice_Mails"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/mails/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Voice_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "msgnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dir",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "macrocontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "callerid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "origtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "duration",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mailboxuser",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "mailboxcontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Blob",
+ "optional": true,
+ "field": "recording",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "flag",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "msg_id",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "stamp",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMailMessage/index.js",
+ "groupTitle": "Voice_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/mails/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Voice_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMailMessage/index.js",
+ "groupTitle": "Voice_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mails/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Voice_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMailMessage/index.js",
+ "groupTitle": "Voice_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/mails/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Voice_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMailMessage/index.js",
+ "groupTitle": "Voice_Messages"
+ },
+ {
+ "type": "get",
+ "url": "voice/mails/messages/{id}/download",
+ "title": "Download Voice Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Voice_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMailMessage/index.js",
+ "groupTitle": "Voice_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/mails/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Voice_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceMailMessage/index.js",
+ "groupTitle": "Voice_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/prefixes/{id}/users",
+ "title": "Add agents to a prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/prefixes/{id}",
+ "title": "Deletes a Prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeletePrefixes",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/prefixes/describe",
+ "title": "Gets table info about Prefixes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribePrefixes",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/prefixes/{id}/users",
+ "title": "Gets agents from prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/prefixes",
+ "title": "Gets a list of Prefixes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetPrefixes",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/prefixes/{id}/users",
+ "title": "Removes agents from a prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/prefixes/{id}",
+ "title": "Gets a single Prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowPrefixes",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/prefixes/{id}",
+ "title": "Update an existing prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "Update",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/prefixes",
+ "title": "Create a prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "create",
+ "group": "Voice_Prefixes",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefixes"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/reports/describe",
+ "title": "Gets table info about Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueue_Reports",
+ "group": "Voice_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueueReport/index.js",
+ "groupTitle": "Voice_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/reports",
+ "title": "Gets a list of Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueue_Reports",
+ "group": "Voice_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueueReport/index.js",
+ "groupTitle": "Voice_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/reports/{id}",
+ "title": "Gets a single Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueue_Reports",
+ "group": "Voice_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueueReport/index.js",
+ "groupTitle": "Voice_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/reports/index",
+ "title": "Get Voice Queues Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getVoiceQueuesReport",
+ "group": "Voice_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueueReport/index.js",
+ "groupTitle": "Voice_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/queues/{id}/users",
+ "title": "Add agents to queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/queues/{id}/blacklists",
+ "title": "Add blacklists to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddBlackLists",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/queues/{id}/lists",
+ "title": "Add lists to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddLists",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/queues/{id}/teams",
+ "title": "Add teams to queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/queues/clone",
+ "title": "Clone an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CloneQueues",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Voice_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"inbound\"",
+ "\"outbound\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "musiconhold",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "announce",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rr\"",
+ "\"ringall\"",
+ "\"leastrecent\"",
+ "\"fewestcalls\"",
+ "\"random\"",
+ "\"rrmemory\"",
+ "\"linear\"",
+ "\"wrandom\"",
+ "\"rrordered\""
+ ],
+ "optional": false,
+ "field": "strategy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "servicelevel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "penaltymemberslimit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "retry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "timeoutpriority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "weight",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "wrapuptime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "autofill",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"all\""
+ ],
+ "optional": true,
+ "field": "autopause",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "autopausedelay",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "autopausebusy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "autopauseunavail",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "maxlen",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "setinterfacevar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "setqueueentryvar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "setqueuevar",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "eventmemberstatus",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membermacro",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membergosub",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "announce_frequency",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "min_announce_frequency",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "periodic_announce_frequency",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "random_periodic_announce",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "relative_periodic_announce",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\"",
+ "\"once\""
+ ],
+ "optional": true,
+ "field": "announce_holdtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "announce_position",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "announce_to_first_user",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "announce_position_limit",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"0\"",
+ "\"5\"",
+ "\"10\"",
+ "\"15\"",
+ "\"20\"",
+ "\"30\""
+ ],
+ "optional": true,
+ "field": "announce_round_seconds",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "monitor_format",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "monitor_type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_youarenext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_thereare",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_callswaiting",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_holdtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_minute",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_minutes",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_seconds",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_thankyou",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_reporthold",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_quantity1",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_quantity2",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_periodic_announce",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue_less_than",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "periodic_announce",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinempty",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leavewhenempty",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "reportholdtime",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "ringinuse",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "memberdelay",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"yes\"",
+ "\"no\""
+ ],
+ "optional": true,
+ "field": "timeoutrestart",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "defaultrule",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "acw",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "acwTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialActive",
+ "description": "<p>Active/Disactive Campaign</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"preview\"",
+ "\"progressive\"",
+ "\"power\"",
+ "\"predictive\"",
+ "\"booked\""
+ ],
+ "optional": true,
+ "field": "dialMethod",
+ "description": "<p>Dial Method.</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialLimitChannel",
+ "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialLimitQueue",
+ "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "dialPowerLevel",
+ "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"agentBusyFactor\"",
+ "\"dropRate\""
+ ],
+ "optional": true,
+ "field": "dialPredictiveOptimization",
+ "description": "<p>Only for predictive method.</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "dialPredictiveOptimizationPercentage",
+ "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialPredictiveInterval",
+ "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialOriginateCallerIdName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialOriginateCallerIdNumber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialOriginateTimeout",
+ "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialQueueOptions",
+ "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialQueueTimeout",
+ "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialQueueProject",
+ "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialCongestionMaxRetry",
+ "description": "<p>#Congestion Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialCongestionRetryFrequency",
+ "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialBusyMaxRetry",
+ "description": "<p>#Busy Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialBusyRetryFrequency",
+ "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoAnswerMaxRetry",
+ "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoAnswerRetryFrequency",
+ "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialGlobalMaxRetry",
+ "description": "<p>#Global Max Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialTimezone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialGlobalInterval",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialPrefix",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"always\"",
+ "\"never\"",
+ "\"onlyIfOpen\""
+ ],
+ "optional": true,
+ "field": "dialCheckDuplicateType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialAMDActive",
+ "description": "<p>Active/Disactive AMD</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDInitialSilence",
+ "description": "<p>#AMD Initial Silence</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDGreeting",
+ "description": "<p>#AMD Greeting</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDAfterGreetingSilence",
+ "description": "<p>#AMD After Greeting Silence</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDTotalAnalysisTime",
+ "description": "<p>#AMD Total Analysis Time</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDMinWordLength",
+ "description": "<p>#AMD Min Word Length</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDBetweenWordsSilence",
+ "description": "<p>#AMD Between Words Silence</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDMaximumNumberOfWords",
+ "description": "<p>#AMD Maximum Number Of Words</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDSilenceThreshold",
+ "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAMDMaximumWordLength",
+ "description": "<p>#AMD Maximum Word Length</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialRecallMeTimeout",
+ "description": "<p>#RecallMe Timeout (min:1)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialRecallInQueue",
+ "description": "<p>Active/Disactive Recall In Queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"DESC\"",
+ "\"ASC\""
+ ],
+ "optional": true,
+ "field": "dialOrderByScheduledAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialQueueProject2",
+ "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialAgiAfterHangupClient",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialAgiAfterHangupAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialRandomLastDigitCallerIdNumber",
+ "description": "<p>Random Last Digit (min:1, max:15)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialCutDigit",
+ "description": "<p>Cut Digit (min:1, max:15)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberMaxRetry",
+ "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberRetryFrequency",
+ "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropMaxRetry",
+ "description": "<p>#Drop Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropRetryFrequency",
+ "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedMaxRetry",
+ "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedRetryFrequency",
+ "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineMaxRetry",
+ "description": "<p>#Machine Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineRetryFrequency",
+ "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectMaxRetry",
+ "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectRetryFrequency",
+ "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialPredictiveIntervalMaxThreshold",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialPredictiveIntervalMinThreshold",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/blacklists",
+ "title": "Get queue blacklists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetBlackLists",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/finals",
+ "title": "Gets queue hopper finals",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperFinals",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/hopper_histories",
+ "title": "Gets queue hopper histories",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHopperHistories",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/hoppers",
+ "title": "Gets queue hoppers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetHoppers",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/lists",
+ "title": "Get queue lists",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetLists",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/members",
+ "title": "Gets queue members",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/teams",
+ "title": "Gets queue team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/queues/{id}/blacklists",
+ "title": "Remove blacklists from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveBlackLists",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/queues/{id}/lists",
+ "title": "Remove lists from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveLists",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/queues/{id}/blacks",
+ "title": "Gets queue hopper blacks",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getHopperBlacks",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Voice_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueue/index.js",
+ "groupTitle": "Voice_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/recordings",
+ "title": "Creates a new Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateRecordings",
+ "group": "Voice_Recordings",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "format",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "membername",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "calleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "connectedlinenum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "connectedlinename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "rating",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "queue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userSecondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userThirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "location",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transcribeName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transcribeStatus",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "fileUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "fileText",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "failureReason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sentiment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sPositive",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sNegative",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sNeutral",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sMixed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "tempSentiment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "createdAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "updatedAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings/describe",
+ "title": "Gets table info about Recordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeRecordings",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings",
+ "title": "Gets a list of Recordings",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetRecordings",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings/{id}",
+ "title": "Gets a single Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowRecordings",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/recordings/{id}",
+ "title": "Delete voice recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "destroy",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings/{id}/download",
+ "title": "Download Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings/{id}/downloads",
+ "title": "Download Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "downloads",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/recordings/{id}/transcribe",
+ "title": "Run Transcribe Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "transcribe",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings/{id}/transcribe",
+ "title": "Run Transcribe Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "transcribe",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/recordings/{id}",
+ "title": "Update an existing Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateRecordings",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "post",
+ "url": "/api/voice/transfers/reports",
+ "title": "Creates a new Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"blind\"",
+ "\"attended\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "result",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfererchannel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transferercalleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transferercalleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfererconnectedlinenum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfererconnectedlinename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereraccountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transferercontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfererexten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfererlinkedid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereechannel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereecalleridnum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereecalleridname",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereeconnectedlinenum",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereeconnectedlinename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereeaccountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereecontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereeexten",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transfereelinkedid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"Yes\"",
+ "\"No\""
+ ],
+ "optional": true,
+ "field": "isexternal",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "context",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "extension",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/transfers/reports/{id}",
+ "title": "Deletes a Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/transfers/reports",
+ "title": "Gets a list of Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/transfers/reports/{id}",
+ "title": "Gets a single Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/voice/transfers/reports/{id}",
+ "title": "Update an existing Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/vtiger/accounts",
+ "title": "Creates a new Vtiger Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateVtiger_Accounts",
+ "group": "Vtiger_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "moduleName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "accessKey",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/vtiger/accounts/{id}",
+ "title": "Deletes a Vtiger Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteVtiger_Accounts",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/accounts",
+ "title": "Gets a list of Vtiger Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetVtiger_Accounts",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/accounts/{id}",
+ "title": "Gets a single Vtiger Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowVtiger_Accounts",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/vtiger/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/vtiger/accounts/{id}",
+ "title": "Update an existing Vtiger Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateVtiger_Accounts",
+ "group": "Vtiger_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerAccount/index.js",
+ "groupTitle": "Vtiger_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/vtiger/configurations",
+ "title": "Creates a new Vtiger Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateVtiger_Configurations",
+ "group": "Vtiger_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/vtiger/configurations/{id}",
+ "title": "Deletes a Vtiger Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteVtiger_Configurations",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/configurations",
+ "title": "Gets a list of Vtiger Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetVtiger_Configurations",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/configurations/{id}",
+ "title": "Gets a single Vtiger Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowVtiger_Configurations",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/vtiger/configurations/{id}",
+ "title": "Update an existing Vtiger Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateVtiger_Configurations",
+ "group": "Vtiger_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerConfiguration/index.js",
+ "groupTitle": "Vtiger_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/vtiger/fields",
+ "title": "Creates a new Vtiger Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateVtiger_Fields",
+ "group": "Vtiger_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerField/index.js",
+ "groupTitle": "Vtiger_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/vtiger/fields/{id}",
+ "title": "Deletes a Vtiger Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteVtiger_Fields",
+ "group": "Vtiger_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerField/index.js",
+ "groupTitle": "Vtiger_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/fields",
+ "title": "Gets a list of Vtiger Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetVtiger_Fields",
+ "group": "Vtiger_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerField/index.js",
+ "groupTitle": "Vtiger_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/vtiger/fields/{id}",
+ "title": "Gets a single Vtiger Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowVtiger_Fields",
+ "group": "Vtiger_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerField/index.js",
+ "groupTitle": "Vtiger_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/vtiger/fields/{id}",
+ "title": "Update an existing Vtiger Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateVtiger_Fields",
+ "group": "Vtiger_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intVtigerField/index.js",
+ "groupTitle": "Vtiger_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/answer",
+ "title": "answer webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_answer",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/calls",
+ "title": "webrtc call list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_calls",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/hangup",
+ "title": "hangup webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_hangup",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/unhold",
+ "title": "unhold webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_hold",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/hold",
+ "title": "hold webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_hold",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/originate",
+ "title": "Originate new webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_originate",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callNumber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callerId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callbackUrl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/transfer",
+ "title": "blind transfer webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_transfer",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "string",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "string",
+ "optional": false,
+ "field": "transferNumber",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/users",
+ "title": "Add agents to a whatsapp account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts",
+ "title": "Creates a new Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAccounts",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "remote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"twilio\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountSid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "authToken",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notificationTemplate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationSound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationShake",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "queueTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "queueTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "agentTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}",
+ "title": "Deletes a Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts",
+ "title": "Gets a list of Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/users",
+ "title": "Gets agents from whatsapp account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}/users",
+ "title": "Removes agents from a whatsapp account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}",
+ "title": "Gets a single Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/applications",
+ "title": "Gets account applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/notify",
+ "title": "Notify new message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "notify",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion 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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/send",
+ "title": "Send new whatsapp message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "sendWhatsapp",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/messages/{id}/status",
+ "title": "Receive message status",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "statusMessage",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/accounts/{id}",
+ "title": "Update an existing Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/applications",
+ "title": "Creates a new Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateApplications",
+ "group": "Whatsapp_Applications",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/applications",
+ "title": "Gets a list of Applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Whatsapp_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/interactions/{id}/messages",
+ "title": "Creates new messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Whatsapp_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/{id}/download",
+ "title": "Gets interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Whatsapp_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/reports/queue",
+ "title": "Creates a new Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/reports/queue/{id}",
+ "title": "Deletes a Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/queue/describe",
+ "title": "Gets table info about Whatsapp Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/queue",
+ "title": "Gets a list of Whatsapp Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/queue/{id}",
+ "title": "Gets a single Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/reports/queue/{id}",
+ "title": "Update an existing Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Whatsapp_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": true,
+ "field": "strategy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/reports/transfer",
+ "title": "Creates a new Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/reports/transfer/{id}",
+ "title": "Deletes a Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/transfer/describe",
+ "title": "Gets table info about Whatsapp Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/transfer",
+ "title": "Gets a list of Whatsapp Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/transfer/{id}",
+ "title": "Gets a single Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/reports/transfer/{id}",
+ "title": "Update an existing Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zendesk/accounts",
+ "title": "Creates a new Zendesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateZendesk_Accounts",
+ "group": "Zendesk_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "username",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "password",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "remoteUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"password\"",
+ "\"token\""
+ ],
+ "optional": true,
+ "field": "authType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"integrationTab\"",
+ "\"newTab\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/zendesk/accounts/{id}",
+ "title": "Deletes a Zendesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteZendesk_Accounts",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/accounts",
+ "title": "Gets a list of Zendesk Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetZendesk_Accounts",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/accounts/{id}",
+ "title": "Gets a single Zendesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowZendesk_Accounts",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zendesk/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/zendesk/accounts/{id}",
+ "title": "Update an existing Zendesk Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateZendesk_Accounts",
+ "group": "Zendesk_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskAccount/index.js",
+ "groupTitle": "Zendesk_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zendesk/configurations",
+ "title": "Creates a new Zendesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateZendesk_Configurations",
+ "group": "Zendesk_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/zendesk/configurations/{id}",
+ "title": "Deletes a Zendesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteZendesk_Configurations",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/configurations",
+ "title": "Gets a list of Zendesk Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetZendesk_Configurations",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/configurations/{id}",
+ "title": "Gets a single Zendesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowZendesk_Configurations",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/configurations/{id}/tags",
+ "title": "Gets configurations tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getTags",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zendesk/configurations/{id}/tags",
+ "title": "Sets new tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "setTags",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/zendesk/configurations/{id}",
+ "title": "Update an existing Zendesk Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateZendesk_Configurations",
+ "group": "Zendesk_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskConfiguration/index.js",
+ "groupTitle": "Zendesk_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zendesk/fields",
+ "title": "Creates a new Zendesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateZendesk_Fields",
+ "group": "Zendesk_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskField/index.js",
+ "groupTitle": "Zendesk_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/zendesk/fields/{id}",
+ "title": "Deletes a Zendesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteZendesk_Fields",
+ "group": "Zendesk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskField/index.js",
+ "groupTitle": "Zendesk_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/fields",
+ "title": "Gets a list of Zendesk Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetZendesk_Fields",
+ "group": "Zendesk_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskField/index.js",
+ "groupTitle": "Zendesk_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zendesk/fields/{id}",
+ "title": "Gets a single Zendesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowZendesk_Fields",
+ "group": "Zendesk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskField/index.js",
+ "groupTitle": "Zendesk_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/zendesk/fields/{id}",
+ "title": "Update an existing Zendesk Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateZendesk_Fields",
+ "group": "Zendesk_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZendeskField/index.js",
+ "groupTitle": "Zendesk_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zoho/accounts",
+ "title": "Creates a new Zoho Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateZoho_Accounts",
+ "group": "Zoho_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "host",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "zone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clientId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clientSecret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "serverUrl",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "code",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "refreshToken",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/zoho/accounts/{id}",
+ "title": "Deletes a Zoho Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteZoho_Accounts",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/accounts",
+ "title": "Gets a list of Zoho Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetZoho_Accounts",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/accounts/{id}",
+ "title": "Gets a single Zoho Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowZoho_Accounts",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zoho/accounts/{id}/configurations",
+ "title": "Creates new configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addConfiguration",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/accounts/{id}/configurations",
+ "title": "Gets account configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getConfigurations",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/accounts/{id}/fields",
+ "title": "Gets account fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/zoho/accounts/{id}",
+ "title": "Update an existing Zoho Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateZoho_Accounts",
+ "group": "Zoho_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoAccount/index.js",
+ "groupTitle": "Zoho_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zoho/configurations",
+ "title": "Creates a new Zoho Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateZoho_Configurations",
+ "group": "Zoho_Configurations",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"lead\"",
+ "\"contact\"",
+ "\"nothing\""
+ ],
+ "optional": true,
+ "field": "moduleCreate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"contact_lead\"",
+ "\"contact\"",
+ "\"lead\""
+ ],
+ "optional": true,
+ "field": "moduleSearch",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/zoho/configurations/{id}",
+ "title": "Deletes a Zoho Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteZoho_Configurations",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/configurations",
+ "title": "Gets a list of Zoho Configurations",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetZoho_Configurations",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/configurations/{id}",
+ "title": "Gets a single Zoho Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowZoho_Configurations",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/configurations/{id}/descriptions",
+ "title": "Gets configurations descriptions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDescriptions",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/configurations/{id}/fields",
+ "title": "Gets configurations fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getFields",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/configurations/{id}/subjects",
+ "title": "Gets configurations subjects",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getSubjects",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/zoho/configurations/{id}",
+ "title": "Update an existing Zoho Configuration",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateZoho_Configurations",
+ "group": "Zoho_Configurations",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoConfiguration/index.js",
+ "groupTitle": "Zoho_Configurations"
+ },
+ {
+ "type": "post",
+ "url": "/api/integrations/zoho/fields",
+ "title": "Creates a new Zoho Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateZoho_Fields",
+ "group": "Zoho_Fields",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\"",
+ "\"keyValue\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "content",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"string\"",
+ "\"variable\"",
+ "\"customVariable\""
+ ],
+ "optional": true,
+ "field": "keyType",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "keyContent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "idField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "nameField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "customField",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "variableName",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoField/index.js",
+ "groupTitle": "Zoho_Fields"
+ },
+ {
+ "type": "delete",
+ "url": "/api/integrations/zoho/fields/{id}",
+ "title": "Deletes a Zoho Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteZoho_Fields",
+ "group": "Zoho_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoField/index.js",
+ "groupTitle": "Zoho_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/fields",
+ "title": "Gets a list of Zoho Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetZoho_Fields",
+ "group": "Zoho_Fields",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoField/index.js",
+ "groupTitle": "Zoho_Fields"
+ },
+ {
+ "type": "get",
+ "url": "/api/integrations/zoho/fields/{id}",
+ "title": "Gets a single Zoho Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowZoho_Fields",
+ "group": "Zoho_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoField/index.js",
+ "groupTitle": "Zoho_Fields"
+ },
+ {
+ "type": "put",
+ "url": "/api/integrations/zoho/fields/{id}",
+ "title": "Update an existing Zoho Field",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateZoho_Fields",
+ "group": "Zoho_Fields",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/intZohoField/index.js",
+ "groupTitle": "Zoho_Fields"
+ },
+ {
+ "type": "post",
+ "url": "/api/cdr",
+ "title": "Creates a new Cdr",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCdrs",
+ "group": "cdr",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "calldate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "clid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "src",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dst",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dcontext",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "channel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dstchannel",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastapp",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "duration",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "billsec",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "amaflags",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountcode",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userfield",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "linkedid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sequence",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "peeraccount",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "tag",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cdr/index.js",
+ "groupTitle": "cdr"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cdr/{id}",
+ "title": "Deletes a Cdr",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCdrs",
+ "group": "cdr",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cdr/index.js",
+ "groupTitle": "cdr"
+ },
+ {
+ "type": "get",
+ "url": "/api/cdr/describe",
+ "title": "Gets table info about Cdrs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeCdrs",
+ "group": "cdr",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cdr/index.js",
+ "groupTitle": "cdr"
+ },
+ {
+ "type": "get",
+ "url": "/api/cdr",
+ "title": "Gets a list of Cdrs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCdrs",
+ "group": "cdr",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/cdr/index.js",
+ "groupTitle": "cdr"
+ },
+ {
+ "type": "get",
+ "url": "/api/cdr/{id}",
+ "title": "Gets a single Cdr",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCdrs",
+ "group": "cdr",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cdr/index.js",
+ "groupTitle": "cdr"
+ },
+ {
+ "type": "put",
+ "url": "/api/cdr/{id}",
+ "title": "Update an existing Cdr",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateCdrs",
+ "group": "cdr",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cdr/index.js",
+ "groupTitle": "cdr"
+ },
+ {
+ "type": "post",
+ "url": "/api/voiceQueuesLog",
+ "title": "Creates a new VoiceQueuesLog",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateVoiceQueuesLogs",
+ "group": "voiceQueuesLog",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "time",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "queuename",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "agent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "event",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "data",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "data1",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "data2",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "data3",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "data4",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "data5",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "dtm",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueuesLog/index.js",
+ "groupTitle": "voiceQueuesLog"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voiceQueuesLog/{id}",
+ "title": "Deletes a VoiceQueuesLog",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteVoiceQueuesLogs",
+ "group": "voiceQueuesLog",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueuesLog/index.js",
+ "groupTitle": "voiceQueuesLog"
+ },
+ {
+ "type": "get",
+ "url": "/api/voiceQueuesLog",
+ "title": "Gets a list of VoiceQueuesLogs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetVoiceQueuesLogs",
+ "group": "voiceQueuesLog",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueuesLog/index.js",
+ "groupTitle": "voiceQueuesLog"
+ },
+ {
+ "type": "get",
+ "url": "/api/voiceQueuesLog/{id}",
+ "title": "Gets a single VoiceQueuesLog",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowVoiceQueuesLogs",
+ "group": "voiceQueuesLog",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueuesLog/index.js",
+ "groupTitle": "voiceQueuesLog"
+ },
+ {
+ "type": "put",
+ "url": "/api/voiceQueuesLog/{id}",
+ "title": "Update an existing VoiceQueuesLog",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateVoiceQueuesLogs",
+ "group": "voiceQueuesLog",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceQueuesLog/index.js",
+ "groupTitle": "voiceQueuesLog"
+ }
+]