11 Dial String Rewriting
11.1 Get
GET https://<HOST>:<PORT>/api/dialStringRewriting/get?version=0
Returns the specified dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
dialStringRewriting
Display name or ID of the dial string rewriting object. If not provided, all dial string rewriting objects will be returned.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewriting JSON objects. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Example
11.2 Set
PUT https://<HOST>:<PORT>/api/dialStringRewriting/set?version=0
Modifies the selected dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
dialStringRewriting
The ID of the dial string rewriting object.
Request Body Structure
The request body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Response Body Structure
The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Example
11.3 Add
POST https://<HOST>:<PORT>/api/dialStringRewriting/add?version=0
Adds a new dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request Body Structure
The request body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Response Body Structure
The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Example
11.4 Remove
DELETE https://<HOST>:<PORT>/api/dialStringRewriting/remove?version=0
Removes a dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
dialStringRewriting
Display name or ID of the dial string rewriting object to be removed.
Example
11.5 Get Rules
GET https://<HOST>:<PORT>/api/dialStringRewriting/rules/get?version=0
Returns the rewriting rules of the choosen dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
dialStringRewriting
Display name or ID of the dial string rewriting object to request rules from.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewriting JSON objects. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Example
11.6 Set Rules
PUT https://<HOST>:<PORT>/api/dialStringRewriting/rules/set?version=0
Replaces the rewriting rules of the choosen dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
dialStringRewriting
Display name or ID of the dial string rewriting object the rewriting rules should be modified of.
Request Body Structure
The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.
Response Body Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.
Example
11.7 Import Rules
PUT https://<HOST>:<PORT>/api/dialStringRewriting/rules/import?version=0
Imports dial string rewriting rules into the specified dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
filename
The path to the file that will be imported.
-
json
Type: Boolean
Determines if the uploaded file is in the JSON format. Defaults to false.
-
dialStringRewriting
Display name or ID of the dial string rewriting object to add rewriting rules to.
Request Body Structure
The request expects the .csv or .json file that should be imported.
Example
11.8 Export Rules
GET https://<HOST>:<PORT>/api/dialStringRewriting/rules/export?version=0
Exports dial string rewriting rules from the specified dial string rewriting object as JSON.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
filename
(Optional) Name of the exported file.
-
backendName
(Optional) If there are additionally configured backends...
-
dialStringRewriting
Display name or ID of the dial string rewriting object to add rewriting rules to.
Example
11.9 Add Rules
POST https://<HOST>:<PORT>/api/dialStringRewriting/rules/add?version=0
Add dial string rewriting rules to the specified dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
dialStringRewriting
Display name or ID of the dial string rewriting object the rewriting rules should be modified of.
Request Body Structure
The request body is structured as DialStringRewrite JSON object. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.
Response Body Structure
The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Example
11.10 Remove Rules
DELETE https://<HOST>:<PORT>/api/dialStringRewriting/rules/remove?version=0
Removes a dial string rewriting rule of the specified dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
index
The index of the rule that will be removed. Either this or the parameter rule must be provided.
-
rule
The display name of the rule that will be removed. Either this or the parameter index must be provided.
-
dialStringRewriting
Display name or ID of the dial string rewriting object the rewriting rules should be modified of.
Response Body Structure
The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.
Example
11.11 Clear Rules
DELETE https://<HOST>:<PORT>/api/dialStringRewriting/rules/clear?version=0
Removes all dial string rewriting rules of the specified dial string rewriting object.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
dialStringRewriting
Display name or ID of the dial string rewriting object the rewriting rules should be modified of.
Response Body Structure
The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 27.13.1. For the JSON schema refer to section 27.13.2.