Available translations





loading results
API Query Parameter


This node represent a single query parameter. For a full definition of what a query parameter is please see the API Query Parameters page.

Этот узел представляет собой один параметр запроса. Для полного определения того, что такое параметр запроса, пожалуйста, смотрите страницу API Query Parameters.

Bu düğüm tek bir sorgu parametresini temsil eder. Sorgu parametresinin ne olduğuna dair tam bir tanım için lütfen API Sorgu Parametreleri sayfasına bakın.
Tip: Even if you are not using every query parameter offered for an endpoint. For the sake of completeness, it is a good idea to add it to the map and delete the value property.
Tip: Даже если вы не используете все параметры запроса, предлагаемые для конечной точки. Для полноты картины рекомендуется добавить его на карту и удалить свойство value.
Tip: Bir uç nokta için sunulan her sorgu parametresini kullanmıyor olsanız bile. Bütünlük adına, haritaya eklemek ve değer özelliğini silmek iyi bir fikirdir.
API Query Parameter Configuration
Конфигурация API Query Parameter
API Sorgu Parametresi Yapılandırması
Properties
Свойства
Özellikler
- codeName: This must match with the name of the query parameter defined at the API docs.
- codeName: Оно должно совпадать с именем параметра запроса, определенным в документации API.
- codeName: Bu, API dokümanlarında tanımlanan sorgu parametresinin adıyla eşleşmelidir.
- isString: Define if the path parameter is a string or not.
- isString: Определите, является ли параметр пути строкой или нет.
- isString: Yol parametresinin bir dize olup olmadığını tanımlar.
- isOptional: Define if this path parameter is optional or not.
- isOptional: Определите, является ли этот параметр пути необязательным или нет.
- isOptional: Bu yol parametresinin isteğe bağlı olup olmadığını tanımlar.
- description: Define a basic description of what this path parameter accomplishes.
- description: Определите базовое описание того, что выполняет этот параметр пути.
- Açıklama: Bu yol parametresinin ne yaptığına dair temel bir açıklama tanımlayın.
- value: This is the value to be used by the parameter.
- value: Это значение, которое будет использоваться параметром.
- değer: Parametre tarafından kullanılacak değerdir.
Note: The value you type into the API Map will be considered the default value. The same parameter can be dynamically pulled from a users system using the replaceBy property. When the replaceBy property is used the default value will be overwritten.
Note: Значение, которое вы вводите в API Map, будет считаться значением по умолчанию. Тот же параметр может быть динамически извлечен из пользовательской системы с помощью свойства replaceBy. Когда используется свойство replaceBy, значение по умолчанию будет перезаписано.
Note: API Haritasına yazdığınız değer varsayılan değer olarak kabul edilecektir. Aynı parametre replaceBy özelliği kullanılarak bir kullanıcının sisteminden dinamik olarak çekilebilir. replaceBy özelliği kullanıldığında varsayılan değerin üzerine yazılacaktır.
- replaceBy: [Optional] This property allows you to instruct the API Fetcher Bot to set a value to this parameter replacing the current default and using contextual information available only at runtime.
- replaceBy: [Необязательно] Это свойство позволяет указать боту API Fetcher Bot установить значение этого параметра, заменяя текущее значение по умолчанию и используя контекстную информацию, доступную только во время выполнения.
- replaceBy: [İsteğe bağlı] Bu özellik, API Fetcher Bot'a bu parametreye geçerli varsayılanın yerine bir değer ayarlaması ve yalnızca çalışma zamanında kullanılabilen bağlamsal bilgileri kullanması talimatını vermenizi sağlar.
Here is an example config setting a query option to
false
: Вот пример конфигурации, устанавливающей для параметра запроса значение
false
: İşte bir sorgu seçeneğini
false
olarak ayarlayan örnek bir yapılandırma: {
"codeName": "localization",
"isString": false,
"isOptional": true,
"description": "Trim down responce object",
"value": false
}
Foundations->Concept->replaceBy Config Property->How To Use It
replaceBy Config Property Usage
Использование replaceBy Config Property
replaceBy Config Özelliğinin Kullanımı ( replaceBy Config Property Usage )
This property is optional, meaning that the Bot will use the default value when it is not present. The default value for both API Query Parameter and API Path Parameter is the
codeName
config property. An example of how this would look in a config is as follows: Это свойство является необязательным, что означает, что бот будет использовать значение по умолчанию, когда оно отсутствует. Значение по умолчанию для API Query Parameter и API Path Parameter - это свойство конфигурации
codeName.
Пример того, как это будет выглядеть в конфигурации, выглядит следующим образом: Bu özellik isteğe bağlıdır, yani mevcut olmadığında Bot varsayılan değeri kullanacaktır. Hem API Sorgu Parametresi ( API Query Parameter ) hem de API Yol Parametresi ( API Path Parameter ) için varsayılan değer
codeName
yapılandırma özelliğidir. Bunun bir yapılandırmada nasıl görüneceğine dair örnek aşağıdaki gibidir: {
"codeName": "currentBaseAsset",
"isString": false,
"isOptional": false,
"description": "",
"replaceBy": "@BaseAsset"
}
The following list lays out all the possible values you can use within the
replaceBy
property. В следующем списке перечислены все возможные значения, которые вы можете использовать в свойстве
replaceBy.
Aşağıdaki liste
replaceBy
özelliği içinde kullanabileceğiniz tüm olası değerleri ortaya koymaktadır. For Base Asset
Для Base Asset
Temel Varlık için ( For Base Asset )
- @BaseAsset: This will force the Bot to use the current Base Asset.
- @BaseAsset: Это заставит бота использовать текущий базовый актив Base asset.
- @BaseAsset: Bu, Botu mevcut Temel Varlığı ( Base Asset ) kullanmaya zorlayacaktır.
parameterValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.baseAsset.referenceParent.config.codeName
- @BaseAssetNameUppercase: This will force the Bot to use the current name of the Base Asset beginning with an uppercase letter.
- @BaseAssetNameUppercase: Это заставит бота использовать текущее имя базового актива Base asset, начинающееся с заглавной буквы.
- @BaseAssetNameUppercase: Bu, Bot'u Temel Varlığın ( Base Asset ) büyük harfle başlayan geçerli adını kullanmaya zorlayacaktır.
rawValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.baseAsset.referenceParent.name
parameterValue = rawValue.toUpperCase()
- @BaseAssetNameLowercase: This will force the Bot to use the name of the current Base Asset beginning with a lowercase letter.
- @BaseAssetNameLowercase: Это заставит бота использовать имя текущего базового актива Base Asset, начинающееся со строчной буквы.
- @BaseAssetNameLowercase: Bu, Bot'u küçük harfle başlayan geçerli Temel Varlığın ( Base Asset ) adını kullanmaya zorlayacaktır.
rawValue = TS.projects.foundations.globals.taskConstants.TASK_NODE.parentNode
.parentNode.parentNode.referenceParent.baseAsset.referenceParent.name
parameterValue = rawValue.toLowerCase()
For Quoted Asset
Для Quoted Asset
Kote Edilen Varlık İçin ( For Quoted Asset )
- @QuotedAsset: This will force the Bot to use the current Quoted Asset.
- @QuotedAsset: Это заставит бота использовать текущий котируемый актив Quoted Asset.
- @QuotedAsset: Bu, Bot'u mevcut Kote Edilen Varlığı ( Quoted Asset ) kullanmaya zorlayacaktır.
parameterValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.quotedAsset.referenceParent.config.codeName
- @QuotedAssetNameUppercase: This will force the Bot to use the name of the current Base Asset beginning with an uppercase letter.
- @QuotedAssetNameUppercase: Это заставит бота использовать имя текущего базового актива Base Asset, начинающееся с заглавной буквы.
- @QuotedAssetNameUppercase: Bu, Bot'u büyük harfle başlayan geçerli Temel Varlığın ( Base Asset ) adını kullanmaya zorlayacaktır.
rawValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.quotedAsset.referenceParent.name
parameterValue = rawValue.toUpperCase()
- @QuotedAssetNameLowercase: This will force the Bot to use the name of the current Base Asset beginning with a lowercase letter.
- @QuotedAssetNameLowercase: Это заставит бота использовать имя текущего базового актива Base Asset, начинающееся со строчной буквы.
- @QuotedAssetNameLowercase: Bu, Bot'u küçük harfle başlayan geçerli Temel Varlığın ( Base Asset ) adını kullanmaya zorlayacaktır.
rawValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.quotedAsset.referenceParent.name
parameterValue = rawValue.toLowerCase()
For Exchange
Для Exchange
Borsa için ( For Exchange )
- @Exchange: This will force the Bot to use the current Exchange.
- @Exchange: Это заставит бота использовать текущую биржу current Exchange.
- @Exchange: Bu, Bot'u mevcut Borsayı kullanmaya zorlayacaktır.
parameterValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.parentNode.parentNode.config.codeName
- @ExchangeNameUppercase: This will force the Bot to use the name of the current Exchange beginning with an uppercase letter.
- @ExchangeNameUppercase: Это заставит бота использовать название текущей биржи
currentExchange
, начинающееся с заглавной буквы.
- @ExchangeNameUppercase: Bu, Bot'u büyük harfle başlayan geçerli Borsa adını kullanmaya zorlayacaktır.
rawValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.parentNode.parentNode.name
parameterValue = rawValue.toUpperCase()
- @ExchangeNameLowercase: This will force the Bot to use the name of the current Exchange beginning with a lowercase letter.
- @ExchangeNameLowercase: Это заставит бота использовать название текущей биржи current Exchange, начинающееся со строчной буквы.
- @ExchangeNameLowercase: Bu, Bot'u küçük harfle başlayan geçerli Borsa adını kullanmaya zorlayacaktır.
rawValue = TS.projects.foundations.globals.taskConstants.TASK_NODE
.parentNode.parentNode.parentNode.referenceParent.parentNode.parentNode.name
parameterValue = rawValue.toLowerCase()
For Timestamp
Для Timestamp
Zaman Damgası için ( For Timestamp )
- @BeginCurrentMinute: This will instruct the Bot to use a timestamp at the beginning of the current minute.
- @BeginCurrentMinute: Это проинструктирует бота использовать метку времени в начале текущей минуты.
- @BeginCurrentMinute: Bu, Bot'a geçerli dakikanın başında bir zaman damgası kullanması talimatını verecektir.
parameterValue =
Math.trunc((new Date()).valueOf() /
SA.projects.foundations.globals.timeConstants.ONE_MIN_IN_MILISECONDS) *
SA.projects.foundations.globals.timeConstants.ONE_MIN_IN_MILISECONDS
- @EndCurrentMinute: This will instruct the Bot to use a timestamp at the ending of the current minute.
- @EndCurrentMinute: Это проинструктирует бота использовать метку времени в конце текущей минуты.
- @EndCurrentMinute: Bu, Bot'a geçerli dakikanın sonunda bir zaman damgası kullanması talimatını verecektir.
parameterValue = Math.trunc((new Date()).valueOf() /
SA.projects.foundations.globals.timeConstants.ONE_MIN_IN_MILISECONDS) *
SA.projects.foundations.globals.timeConstants.ONE_MIN_IN_MILISECONDS +
SA.projects.foundations.globals.timeConstants.ONE_MIN_IN_MILISECONDS - 1
Note: If users access a value that is not listed above, the property will be ignored and the default value will be used.
Note: Если пользователи получают доступ к значению, которого нет в списке выше, свойство будет проигнорировано и будет использоваться значение по умолчанию.
Note: Kullanıcılar yukarıda listelenmeyen bir değere erişirse, özellik yok sayılır ve varsayılan değer kullanılır.
Tip: Name values are drawn from the asset labels held within the Exchange Assets node.
Tip: Значения имен берутся из меток активов, хранящихся в узле Exchange Assets.
Tip: Ad değerleri, Borsa Varlıkları ( Exchange Assets ) düğümünde tutulan varlık etiketlerinden alınır
Initial Values
These are the Initial Values for API Query Parameter configuration:
{
"codeName": "",
"isString": false,
"isOptional": false,
"description": ""
}
Examples
This is a list of properties featured by the API Query Parameter configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
API Query Parameter Menu
The API Query Parameter node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- actionFunction:
uiObject.configEditor.activate
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that API Query Parameter already has the required child type that the menu item may add, and only that child is allowed for that case.
API Query Parameter Attaching Rules
The following are the Node Attaching Rules that govern the attachment of API Query Parameter with other nodes:
Compatible Types: