Component Operation
:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:
Description
A multifunctional component that provides various utility methods for influencing the system.
Index |
|
Short name |
|
Script types |
|
Start module |
|
Mode |
Asynchronous |
Icon |
|
Branching type |
Branching, closing |
Limitations
-
Tokens integration channels (token_local) are issued in clear text only once - in the creation response; re-issuance of a token - only for a user session (not available to the script). Reading (methods “Get” and “Search by key”) returns the token encrypted (ha_v=5;…, Encryption and keys) or a mask with a fingerprint (*****#<8 hex>); search and filter by token are not supported.
Properties
| Specification | Description |
|---|---|
Name: Operation type Code: Visibility condition: no Default: CRUD in the domain |
Selecting a category of operations. Possible values:
|
Name: Domain Code: Visibility condition: yes Default: Scenarios |
Select the domain in which the operation is performed. Applies to CRUD operations in a domain. Possible values:
|
Name: Domain name
Code: Default: — |
An argument containing the name of the domain to perform the operation on entities. Only specifying domains from a child tree is allowed. Applies to CRUD operations in a domain. |
Name: User login Code: Visibility condition: yes Default: — |
Argument containing the user’s login in the domain. Applies to CRUD operations in a domain. The user must have suitable access rights (admin or crud* role to access domain center collections) and the 'allow_script_crud' option set. Default user system is created in the domain with allowed access. If it is necessary to tighten policies, the rights of this user should be revoked. To access a domain other than the script domain, the specified user account must be created in the script domain and in the target domain, and they have the same password. Rights may vary. This ensures that agreements between domains are synchronized. |
Name: Entity type Code: Visibility condition: yes Default: — |
An argument containing the name of the entity class. Applies to CRUD operations in a domain. |
Name: Method
Code: Default: Create |
Select operation. Possible values:
Applies to CRUD operations in a domain. |
Name: Data
Code: Default: — |
An argument containing either a json object with field values when creating or updating, or with an identifier when deleting. Applies to CRUD operations in a domain. For rules on forming expressions for JSON values, see JSON escaping and Templates. |
Name: Filter
Code: Default: — |
Search filter for the operation of obtaining entities of the CRUD category in the domain. Specified as a JSON structure containing an object. Order of indication and application (filter parameter). Example 1 (general REST format)
Example 2 (domain center format)
|
Name: Sort Code: Visibility condition: yes Default: — |
Sorting mode for the operation of obtaining entities of the CRUD category in the domain. Specified as a JSON structure containing an array. Order of indication and application (order parameter). Example 1
Example 2
Example 3
|
Name: Additional parameters Code: Visibility condition: yes Default: — |
Additional parameters to the request to the domain center in JSON format to obtain entities of the CRUD category in the domain. Example 1
Example 2
|
Name: Fields Code: Visibility condition: yes Default: — |
Mask for issuing objects (fields) for the operation of obtaining entities of the CRUD category in the domain. Indicated as a string listing the field names separated by commas. Order of indication and application (mask parameter). Example
id, login, phonenumber, opts |
Name: Domain Code: Visibility condition: yes Default: Scenarios |
Select the domain in which the operation is performed. Applies to operations in the Data Model category in a domain. Possible values:
|
Name: Domain name
Code: Default: — |
An argument containing the name of the domain to perform the operation on entities. Only specifying domains from a child tree is allowed. Applies to operations in the Data Model category in a domain. |
Name: User login Code: Visibility condition: yes Default: — |
Argument containing the user’s login in the domain. Applies to operations in the Data Model category in a domain. The user must have suitable access rights (a role corresponding to the routes to the collection endpoints) and the 'allow_script_crud' option set. Default user system is created in the domain with allowed access. If it is necessary to tighten policies, the rights of this user should be revoked. To access a domain other than the script domain, the specified user account must be created in the script domain and in the target domain, and they have the same password. Rights may vary. This ensures that agreements between domains are synchronized. |
Name: Class name Code: Visibility condition: yes Default: — |
An argument containing the name of the dynamic data model class (the classname field in instances of the classes collection). Applies to operations in the Data Model category in a domain. Examples
email/Accounts rest/v1/model/email/Accounts |
Name: Method Code: Visibility condition: yes Default: Create |
Select operation. Possible values:
Applies to operations in the Data Model category in a domain. |
Name: Path (date/datetime)
Code: Default: — |
An argument containing the path to the entity (for history and transactionlog type collections. Date or date/time corresponding to the value from the field specified in class.opts.partition_property). Applies to operations of the Data Model category in the domain in relation to collections of the history and transactionlog types. |
Name: Entity ID Code: Visibility condition: yes Default: — |
Argument containing the entity identifier. Applies to operations in the Data Model category in a domain. |
Name: Property name Code: Visibility condition: yes Default: — |
An argument containing the name of the property containing the target attachment. Applies to operations in the Data Model category in a domain. |
Name: File name (multi) Code: Visibility condition: yes Default: — |
An argument containing the account name of a specific attachment file if the property is a list type. Applies to operations in the Data Model category in a domain. |
Name: Start of interval (date/datetime) Code: Visibility condition: yes Default: — |
An argument containing the date/time of the start of the interval for sampling objects from collections of type history and transactionlog. Applies to operations in the Data Model category in a domain. |
Name: End of interval (date/datetime)
Code: Default: — |
An argument containing the date/time of the end of the interval for sampling objects from collections of type history and transactionlog. Applies to operations in the Data Model category in a domain. |
Name: Filter (json) Code: Visibility condition: yes Default: — |
Argument containing a json list with a description of the filter for selecting collection elements. Applies to operations in the Data Model category in a domain. Order of indication and application (filter parameter). Example
|
Name: Sort (json)
Code: Default: — |
An argument containing a json list describing the sorting sequence of the collection elements. Applies to operations in the Data Model category in a domain. Specified as a JSON value - field, list of fields, list of objects indicating the sorting direction. Order of indication and application (order parameter). Example 1
Example 2
Example 3
|
Name: Mask (json) Code: Visibility condition: yes Default: — |
Argument containing a json list of fields to be selected. Applies to operations in the Data Model category in a domain. Specified as a JSON list of strings - field names. Order of indication and application (mask parameter). Example
|
Name: Shift Code: Visibility condition: yes Default: — |
Argument containing a numeric indicator of the shift in the sample. Applies to operations in the Data Model category in a domain. |
Name: Quantity Code: Visibility condition: yes Default: — |
Argument containing a numeric indicator of the number of elements in the selection. Any collection is forcibly limited from above to a finite value. Applies to operations in the Data Model category in a domain. |
Name: Grouping fields (json) Code: Visibility condition: yes Default: — |
Argument containing a json object from the grouping fields. Element values are lists representing a function for calculating the aggregation base. Applies to operations in the Data Model category in a domain. |
Name: Aggregation fields (json) Code: Visibility condition: yes Default: — |
Argument containing a json object from the aggregation fields. Element values are lists representing an aggregation function. Superposition can be applied to calculate complex aggregation metrics. Applies to operations in the Data Model category in a domain. |
Name: Content (json)
Code: Default: — |
An argument containing a json object with field values when saving the entity. Applies to operations in the Data Model category in a domain. For rules on forming expressions for JSON values, see JSON escaping and Templates. |
Name: Default: — |
An argument containing the categorized path to the file to be downloaded as an attachment. Applies to operations in the Data Model category in a domain. |
Name: Entity type Code: Visibility condition: yes Default: — |
Select from a list of types of registered entities. |
Possible values: |
|
|
|
|
Applicable for operations in the Registrar category. |
"Name: Method Code: Visibility condition: yes Default: Get websocket connection |
Select operation. Possible values:
Applies to operations in the Registrar category for the selected entity type Users. |
Name: Method Code: Visibility condition: yes Default: Get registration |
Select operation. Possible values:
Applies to operations in the Registrar category for the selected entity type SIP users. |
Name: Account Code: Visibility condition: yes Default: — |
Argument containing the login or entity identifier. If the value is empty, then all records will be returned. Applies to operations in the Registrar category for the selected entity type Users. |
Name: Account Code: Visibility condition: yes Default: — |
Argument containing the login or entity identifier. If the value is empty, then all records will be returned. Applies to operations in the Registrar category for the selected entity type SIP users. |
Name: Filter Code: Visibility condition: yes Default: — |
Search filter for the operation of obtaining entities of the Registrar category. Specified as a JSON structure containing an object. Order of indication and application (filter parameter). |
Name: Sort Code: Visibility condition: yes Default: — |
Sorting mode for the operation of obtaining entities of the Registrar category. Specified as a JSON structure containing an array. Order of indication and application (order parameter). |
Name: Fields
Code: Default: — |
Mask for issuing objects (fields) for the operation of obtaining entities of the Registrar category. Specified as a JSON structure containing an object. Order of indication and application (mask parameter). |
Name: Additional parameters Code: Visibility condition: yes Default: — |
Additional parameters for the selection operation of the Registrar category. Additional fields: offset, limit, etc. Order of indication and application. |
Name: Method Code: Visibility condition: yes Default: Add |
Select an operation with call context labels. Applies to operations in the Call binding category. Possible values:
|
Name: Call ID Code: Visibility condition: yes Default: — |
Argument containing the call identifier: CallId or DialogId. Applies to operations in the Call binding category. |
Name: Label Code: Visibility condition: yes Default: — |
An argument containing the text content of the label. Applies to operations in the Call binding category. |
Name: Method Code: Visibility condition: yes Default: Outgoing call |
Select an operation to control the call. Applicable for operations in the Call Control category. Possible options:
|
Name: Parameters (JSON) Code: Visibility condition: yes Default: — |
Parameters for the call control operation. The value for each method is a JSON structure in the form of an object with content corresponding to the calls and conferences management APIs. Applicable for operations in the Call Control category. |
Name: Method Code: Visibility condition: yes Default: Install huntblock |
Select method. Possible values:
Applicable for operations in the sipuser Management category. |
Name: Login or Id Code: Visibility condition: yes Default: — |
An argument containing the login or id of the sipuser entity in the domain. Applicable for operations in the sipuser Management category. |
Name: Timeout type Code: Visibility condition: yes Default: Replace |
Select timeout type. Possible values:
Applicable for operations in the sipuser Management category. |
Name: Timeout, sec. Code: Visibility condition: yes Default: — |
The blocking time of the specified sipuser for huntq queues in seconds. Applicable for operations in the sipuser Management category. |
Name: Comment Code: Visibility condition: yes Default: — |
Comment for blocking the specified sipuser for huntq queues. Applies to operations in the sipuser Management category. |
Name: Storage ID Code: Visibility condition: yes Default: — |
Argument containing the storage identifier/code. Applies to operations in the Download conversation recording category. |
Name: Path to storage entry
Code: Default: — |
Argument containing the path to the recording file in the repository. Applies to operations in the Download conversation recording category. |
Name: Domain name Code: Visibility condition: yes Default: — |
An argument containing the domain name for the operation. You can specify any domain existing in the system. Used for operations in the External Authentication category using the Password Check and Session Creation methods. |
Name: Login or Id Code: Visibility condition: yes Default: — |
An argument containing the login or user ID (field value |
Name: Password Code: Visibility condition: yes Default: — |
An argument containing the password (field value Used for operations in the External Authentication category of the Password Verification method. |
Name: wsban data key Code: Visibility condition: yes Default: — |
Argument containing the data key to add the failed attempt to wsban. To resist brute force authentication data, you need to use it when generating the key for wsban. Using a key allows you to avoid blocking incorrectly implemented clients that, despite a negative response to the authentication attempt, continue to send the same data over and over again. For example, Creating Session uses {Domain,Login,Pwd} as the key. The resulting key value is hashed and is not stored explicitly. If you do not pass any field to the key, it will be subject to brute force, because without taking it into account, only one record will be created (if all other fields match), which in itself will not cause blocking. Used for operations in the External Authentication category using the Create Session and Add to wsban methods. |
Name: Indicator code Code: Visibility condition: yes Default: — |
String argument containing the code of the stat service indicator. Applies to operations in the Increase stat service counter category. |
Name: Filter name Code: Visibility condition: yes Default: empty |
Optional string argument containing the name of the filter for the stat service indicator. Applies to operations in the Increase stat service counter category. |
Name: Filter value Code: Visibility condition: yes Default: empty |
Optional argument containing the string filter value for the stat service indicator. Applies to operations in the Increase stat service counter category. |
Name: Argument Code: Visibility condition: yes Default: empty |
Optional argument containing the string value of the argument for the operation to increase the stat service counter. Applies to operations in the Increase stat service counter category. |
Name: Meaning
Code: Default: 1 |
Argument containing a numeric value for the operation of increasing the stat service counter. Applies to operations in the Increase stat service counter category. |
Name: Result into variable Code: Visibility condition: no Default: — |
Variable for storing the result of the operation. |
Name: Transition Code: Visibility condition: no Default: — |
The component to which control is transferred upon successful completion of the operation. |
Name: Transition, time
Code: Default: — |
The component to which control is transferred after the timeout for waiting for the result of the operation. |
Name: Transition, error Code: Visibility condition: no Default: — |
Component to which control is transferred in case of an error. |
See also
-
Role svc
-
Role mdc
-
API call control
-
Component Operation for IVR scripts.