259 lines
31 KiB
HTML
259 lines
31 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<title>API methods in modules</title>
|
||
<meta name="generator" content="Help+Manual" />
|
||
<meta name="keywords" content="" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="description" content="In BRIX, you can create your own custom methods in modules and use them in the Web API, widgets, pages, and process scripts, or when configuring document templates. For..." />
|
||
<meta name="picture" content="" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
|
||
<meta property="og:url" content="https://brix365.com/en/help" />
|
||
<meta property="og:image" content="" />
|
||
<link rel="icon" href="favicon.png" type="image/png" />
|
||
|
||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
|
||
<link rel="stylesheet" href="./jquery-ui.min.css" />
|
||
<link rel="stylesheet" href="default.css" />
|
||
<link rel="stylesheet" href="./search-yandex.css" />
|
||
<link rel="stylesheet" href="./article.css" />
|
||
<link rel="stylesheet" href="./glossary.css" />
|
||
<link rel="stylesheet" href="./theme.css" />
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="helpman_settings.js"></script>
|
||
<script type="text/javascript" src="helpman_topicinit.js"></script>
|
||
|
||
<script type="text/javascript" src="highlight.js"></script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function(){highlight();});
|
||
</script>
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
|
||
|
||
<header class="header elma-365">
|
||
<div class="container">
|
||
<a class="header__logo" href="https://brix365.com/en/help">
|
||
<img src="./logo-en.svg" alt="header logo">
|
||
</a>
|
||
<!-- <div class="hero__search-form" id="search-panel">
|
||
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
|
||
<label class="search-form__label">
|
||
<span id="reset-search" class="search__icon"></span>
|
||
<input class="search-form__input" type="text">
|
||
</label>
|
||
<input class="search-form__submit" type="submit" value="Submit">
|
||
</form>
|
||
</div> -->
|
||
|
||
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
|
||
<div class="hero__search">
|
||
<a href="#" id="search-icon" class="hero__search-icon">
|
||
<img src="search-icon-white.svg" alt="search string">
|
||
</a>
|
||
<a href="#" id="side-menu-icon" class="hero__side-icon">
|
||
<img src="side_menu.svg" alt="side menu">
|
||
</a>
|
||
</div>
|
||
<div class="header__navi">
|
||
|
||
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</header>
|
||
|
||
|
||
|
||
|
||
<main class="main container">
|
||
|
||
<aside class="sidebar" id="sidebar">
|
||
<div class="sidebar__header">
|
||
<a class="header__logo" href="https://brix365.com/en/help">
|
||
<img src="./logo-light-en.svg">
|
||
</a>
|
||
<span class="sidebar__close elma-365-close" id="close"></span>
|
||
</div>
|
||
<div class="sidebar__wrapper" id="side-menu">
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
<article class="article" id="article">
|
||
<div class="article-inner">
|
||
<div class="content">
|
||
<header class="article__header">
|
||
<div class="article__bread" style="display:flex; gap:10px;">
|
||
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
|
||
|
||
<div class="topic__breadcrumbs">
|
||
<p><a href="360024498352.html">Modules</a> > <a href="extentions.html">Custom modules</a> / API methods in modules</p>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">API methods in modules</span></h1>
|
||
</div>
|
||
|
||
</header>
|
||
<section class="article__content">
|
||
<div class="scroll-top-inner">
|
||
<a href="#h1-article" class="scroll-top"></a>
|
||
</div>
|
||
<!-- Placeholder for topic body. -->
|
||
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: Inter;">In BRIX, you can create your own custom methods in modules and use them in the Web API, widgets, pages, and process scripts, or when <a href="another-template-syntax-functions.html#exttext" class="topiclink">configuring document templates</a>. For instance, you can design methods to initiate a business process, conduct complex data retrieval, or establish intermediate communication with an internal or external system.</span></p>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="font-family: Inter;">You can also devise general-purpose functions and reuse them in different places.</span></p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Create a method</span></h2>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="font-family: Inter;">To create a method, do the following:</span></p>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="1" class="p_Normal">Go to <span style="font-weight: bold;">Administration > Modules</span>.</li><li value="2" class="p_Normal">Hover the mouse over the module and click the gear icon.</li></ol>
|
||
<p class="p_Normal" style="margin: 0 0 0 34px;"><img alt="api_modules_01" width="470" height="168" style="margin:0;width:470px;height:168px;border:none" src="api_modules_01.png"/></p>
|
||
<ol style="list-style-type:upper-roman" start="3">
|
||
<li value="3" class="p_Normal">Go to the <span style="font-weight: bold;">API Methods</span> tab.</li><li value="4" class="p_Normal">Click <span style="font-weight: bold;">Edit</span>. The method editor will open.</li><li value="5" class="p_Normal">Click the<span style="font-weight: bold;"> +Add </span>button. In the window that opens, enter the required information.</li></ol>
|
||
<p class="p_Normal" style="margin: 0 0 0 34px;"><img alt="extention-API-1" width="770" height="370" style="margin:0;width:770px;height:370px;border:none" src="extention-api-1.png"/></p>
|
||
<p class="p_Normal"> </p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><span style="font-weight: bold;">Name</span><span style="font-weight: bold; color: #ff0000;">*</span>. Enter the method name.</li><li class="p_Normal"><span style="font-weight: bold;">Address</span><span style="font-weight: bold; color: #ff0000;">*</span>. Select one or more HTTP request methods from the list. The following methods are available: <code><b>GET</b></code>, <code><b>POST</b></code>, <code><b>PUT</b></code>, <code><b>PATCH</b></code>, and <code><b>DELETE</b></code>. Specify at what address the method will be available at. In doing so, you can:<ul style="list-style-type:circle">
|
||
<li class="p_Normal">Specify the path to nested methods. Use a forward slash <code><b>/</b></code> to specify a child method, e.g. <code><b>main/email_dispatch or call_events/route/</b></code><span style="font-size: 15px; font-family: Inter; color: #394149;">. The number of nesting levels is unlimited.</span></li><li class="p_Normal">Specify a wildcard for passing variable values to the method URL. Add a combination of <code><b>/*</b></code> characters at the end of the method address, e.g. <code><b>orders/*</b></code> or <code><b>orders/process/*</b></code>. In the method script you will be able to customize the processing of variable values that are passed when the method is called. For example, you can pass the user ID to get the user's name and e-mail as a result of the request. Read more about scripting such methods and calling them in the <a href="api-method-with-wildcard.html" class="topiclink">Use API methods with wildcards in modules</a> article.<br />
|
||
<br />
|
||
Note, the <code><b>/</b></code> and <code><b>*</b></code> characters at the end of the address do not ensure the uniqueness of the method, so the addresses of two methods cannot differ only by them. For example, if you have already added a <code><b>files/</b></code> method, an error will occur when you try to create a <code><b>files/*</b></code> method<span style="font-size: 15px; font-family: Inter; color: #394149;">.</span></li></ul>
|
||
<li class="p_Normal"><span style="font-weight: bold;">Function</span><span style="font-weight: bold; color: #ff0000;">*</span>. Create a function that will be executed when a request is received.</li><li class="p_Normal"><span style="font-weight: bold;">Authorization</span>. Select an authorization type to use when a request is received.<ul style="list-style-type:circle">
|
||
<li class="p_Normal"><span style="font-weight: bold;">Internal</span>. When this option is selected, the method can only be called within the module, for instance, in other methods, widgets, business processes activities, and event handlers. To call it, you need to use the <code><b>Namespace.api.method_name</b></code> command. Read more <a href="extention-api.html#call-method" class="topiclink">below</a>. The user under whose name the script runs must be logged in to BRIX.</li><li class="p_Normal"><span style="font-weight: bold;">External</span>. When this option is selected, the method will be available from the external system via a <a href="360016488452.html" class="topiclink">token</a>.</li></ul>
|
||
<li class="p_Normal"><span style="font-weight: bold;">Asynchronous start</span>. This option allows you to continue your work without waiting for method execution to finish.</li><li class="p_Normal"><span style="font-weight: bold;">Description</span>. Write a detailed description of the method.</li></ul>
|
||
<ol style="list-style-type:upper-roman" start="6">
|
||
<li value="6" class="p_Normal">Go to the <span style="font-weight: bold;">Scripts</span> tab and write the code. Use the <a href="https://www.typescriptlang.org/" target="_blank" class="weblink">TypeScript</a> programming language. To learn more about the basic principles of script writing in <span style="background-color: #ffffff;">BRIX</span>, please visit <a href="https://tssdk.brix365.com/" target="_blank" class="weblink">BRIX TS SDK</a>.</li><li value="7" class="p_Normal">Save and publish the method.</li></ol>
|
||
<h2 class="p_Heading2"><a id="access-to-global-constants" class="hmanchor"></a><span class="f_Heading2">Access to global constants</span></h2>
|
||
<p class="p_Normal">By default, API methods can only access workspace components at the level of which they are configured. You can additionally access other system objects via a <a href="global-constants.html" class="topiclink">global constant</a>. To do this, in the method editor go to the <span style="font-weight: bold;">Scripts</span> tab and click <span style="font-weight: bold;">Settings</span> in the top panel.</p>
|
||
<p class="p_Normal"><img alt="extention-API-2" width="870" height="336" style="margin:0;width:870px;height:336px;border:none" src="extention-api-2.png"/></p>
|
||
<p class="p_Normal">You can use the following options:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><span style="font-weight: bold;">Global constants</span>. Check the <span style="font-weight: bold;">Global</span> option to be able to refer to objects from all workspaces in the system and to global parameters. The <a href="https://tssdk.brix365.com/en/latest/pages/quick-start/intro_globals.html#global" target="_blank" class="weblink">Global</a> constant is used for this purpose.</li></ul>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало внимание</span></p>
|
||
<p class="p_Normal">When using the <code><b>Global</b></code> constant to write an API method, a module with this method cannot be <a href="export_extention.html" class="topiclink">exported</a>.</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец внимание</span></p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><span style="font-weight: bold;">Optional dependencies (available in the Imports object)</span>. Select workspaces or custom modules and set <a href="optional-dependencies.html" class="topiclink">optional dependencies</a> with them. After that, they can be accessed in scripts via the <a href="optional-dependencies.html#use-imports" class="topiclink">Imports constant</a>.</li></ul>
|
||
<p class="p_Normal" style="margin: 0 0 0 34px;">To create a dependency, click <span style="font-weight: bold;">+Add Workspace</span> and select a system component. Then, in the <span style="font-weight: bold;">Alias</span> column, set a unique name for it that will be used in the script. Latin letters and numbers are acceptable, and you can use an underscore to separate words. By default, the workspace code or module ID is used.</p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Use files in scripts</span></h2>
|
||
<p class="p_Normal">You can use images, document templates, instructions, etc. in the module scripts. To do this, in the method editor, go to the <span style="font-weight: bold;">Files</span> tab and upload the required document.</p>
|
||
<p class="p_Normal"><img alt="api_modules_02" width="1311" height="346" style="margin:0;width:1311px;height:346px;border:none" src="api_modules_02.png"/></p>
|
||
<p class="p_Normal">Open the file in view mode and copy its identifier in the URL of the page. Using the identifier, you can refer to the uploaded file in any module script.</p>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">Server dependencies</span></h3>
|
||
<p class="p_Normal">In BRIX On-Premises, you can add npm packages with server dependencies on the <span style="font-weight: bold;">Files</span> tab. Read more in the <a href="npm-package.html" class="topiclink">Server dependencies of npm packages</a> article.</p>
|
||
<h2 class="p_Heading2"><a id="tracing" class="hmanchor"></a><span class="f_Heading2">Trace API methods</span></h2>
|
||
<p class="p_Normal">If in <span style="font-weight: bold;">Administration > Developer Tools</span>, tracing is enabled for an API method, you can script execution. This helps you evaluate the duration of individual requests, optimize the code, and identify the causes of errors.</p>
|
||
<p class="p_Normal">To view the list of traces, go to the the module settings and open the <span style="font-weight: bold;">API Methods</span> tab. To view the records:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal">By all module methods — click <span style="font-weight: bold;">View tracing</span> in the upper right corner of the page.</li><li class="p_Normal">By certain method — click <img alt="extention-api-3" width="25" height="23" style="margin:0;width:25px;height:23px;border:none" src="extention-api-3.png"/> next to the method.</li></ul>
|
||
<p class="p_Normal">Read more about tracing settings and trace information in the <a href="server-script-tracing.html" class="topiclink">Trace server scripts</a> article.</p>
|
||
<h2 class="p_Heading2"><a id="call-method" class="hmanchor"></a><span class="f_Heading2">Call an API method from a script</span></h2>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;">After creating an API method in a module, you can call it in any script of this module. To do that, use the <code><b>api</b></code> property of the <code><b>Namespace</b></code> global variable:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">let response = await Namespace.api.some_method.call({</span><br />
|
||
<span class="f_CodeExample"> method: "POST",</span><br />
|
||
<span class="f_CodeExample"> headers: {</span><br />
|
||
<span class="f_CodeExample"> "X-My-CutomHeader": "Some header data"</span><br />
|
||
<span class="f_CodeExample"> },</span><br />
|
||
<span class="f_CodeExample"> query: {</span><br />
|
||
<span class="f_CodeExample"> "skip": "0",</span><br />
|
||
<span class="f_CodeExample"> "take": "10"</span><br />
|
||
<span class="f_CodeExample"> }, body: "Any body here"</span><br />
|
||
<span class="f_CodeExample">});</span></p>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="color: #394149;">The </span><code><b>HttpApiRequest</b></code><span style="font-size: 13px;"> </span><span style="color: #394149;">type is sent to the method. It extends the </span><code><b>FetchRequest</b></code><span style="color: #394149;"> type and is used in the </span><code><b>fetch()</b></code><span style="color: #394149;"> method.</span></p>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="color: #394149;">When the </span><code><b>call()</b></code><span style="color: #394149;"> method is called, a web call to the API method is made using the standard HTTP protocol. Therefore, the response from the method comes as a standard </span><code><b>FetchResponse</b></code><span style="color: #394149;"> object.</span></p>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="color: #394149;">To configure modules with webhooks, you can get an API method address using the </span><code><b>Namespace.api.some_method.getUrl()</b></code><span style="color: #394149;"> command. It will return a string with the full address of this method for further calling. This method is useful when an external service requires you to specify a return address for a call.</span></p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Call an API method from an external system</span></h2>
|
||
<p class="p_Normal">An API method in the module can be called from an external service. To do this, a direct link to the created method in the form of a full URL is specified in the web request.</p>
|
||
<p class="p_Normal">To get the link, open the module settings page and go to the <span style="font-weight: bold;">API Methods</span> tab. Next to the method name, click the URL copy icon.</p>
|
||
<p class="p_Normal"><img alt="api_modules_03" width="922" height="380" style="margin:0;width:922px;height:380px;border:none" src="api_modules_03.png"/></p>
|
||
<p>If the external authentication option is selected when creating a method, the request uses the <code><b>Authorization</b></code> header and specifies an individual user token. Read more on the <a href="https://api.brix365.com/en/public-api/guides/WebAPIAuthorization/" target="_blank" class="weblink">BRIX public API</a> page.</p>
|
||
<p>Here is an example of calling an API method in a module via the <code><b>fetch</b></code> command:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">let</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">response</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">=</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">await</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">fetch('https://abcd1234.brix365.en/api/extensions/f1e6cf15-7c65-4be5-8443-021a280dcd80/script/upload',</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">method:</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">"POST",</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">headers:</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">"Authorization":</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">"Bearer "</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">+</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">secureToken</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">},</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">query:</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">"file_id":</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">fileId</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">},</span><br />
|
||
<span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">body:</span><span class="f_CodeExample" style="color: #ffffff;"> </span><span class="f_CodeExample">JSON.stringify(uploadBody)</span><br />
|
||
<span class="f_CodeExample">});</span></p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Service headers</span></h2>
|
||
<p style="line-height: 1.20; margin: 0 0 11px 0;"><span style="font-family: Inter; color: #394149;">In API methods, each request object passed into a script contains headers that store information about the invoked method:</span></p>
|
||
<ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>:method</b></code><span style="font-family: Inter; color: #394149;">. The HTTP method.</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>:path</b></code><span style="font-family: Inter; color: #394149;">. The part of the URL method address that comes after the domain, along with query parameters. For example, </span><code><b>/test1/test2?q=12345&n=aaa</b></code><span style="font-family: Inter; color: #394149;">.</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>:scheme</b></code><span style="font-family: Inter; color: #394149;">. The protocol used in the method: either </span><code><b>http</b></code><span style="font-family: Inter; color: #394149;"> or </span><code><b>https</b></code><span style="font-family: Inter; color: #394149;">.</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>:authority</b></code><span style="font-family: Inter; color: #394149;">. The domain and port (excluding 80 and 443), from which the request originated, for example, </span><code><b>brix365.com</b></code><span style="font-family: Inter; color: #394149;"> or </span><code><b>local.brix365.dev:4200</b></code><span style="font-family: Inter; color: #394149;">.</span></li></ul>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="extension-zones.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">extension-zones.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="api-method-with-wildcard.html">
|
||
<span class="bottom-nav__link">api-method-with-wildcard.html</span> <span
|
||
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
|
||
</a>
|
||
|
||
</div>
|
||
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
|
||
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
|
||
|
||
</section>
|
||
</div>
|
||
<aside class="article__sidebar" style="display:none">
|
||
<input type="checkbox" />
|
||
<div class="article__arrow"></div>
|
||
<div class="table-of-contents elma365-right" id="toc2Content">
|
||
<h3 class="h3-toc">In this topic</h3>
|
||
<nav id="toc2"></nav>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</article>
|
||
</main>
|
||
<footer class="footer">
|
||
<div class="footer-container">
|
||
<div class="footer-mobile">
|
||
|
||
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
|
||
|
||
|
||
</div>
|
||
<div class="footer-wrap">
|
||
|
||
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
|
||
|
||
<div class="footer-flex-b">
|
||
<span class="footer-copy">© 2025 BRIX</span>
|
||
<ul class="footer-list">
|
||
|
||
<li class="footer-item">
|
||
<a href="#" class="arrow-top" style="display: block;"></a>
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
<iframe name="hmnavigation" style="display:none!important"></iframe>
|
||
<script src="./jquery-ui.js"></script>
|
||
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
|
||
<script src="./jquery.tocify.min.js"></script>
|
||
<script src="./TypoReporter.min.js"></script>
|
||
<script src="./google-search.js"></script>
|
||
<script src="./main.js"></script>
|
||
</body>
|
||
|
||
</html>
|