Available translations
loading results
API Response Field
The API responds with a JSON object. Each property of the object is mapped as a node of this type. This node can have children of the same type allowing users to map a complex data structure.
API отвечает объектом JSON. Каждое свойство объекта отображается как узел этого типа. У этого узла могут быть дочерние элементы одного и того же типа, что позволяет пользователям отображать сложную структуру данных.
API, bir JSON nesnesiyle yanıt verir. Nesnenin her özelliği, bu türden bir düğüm olarak eşlenir. Bu düğüm, kullanıcıların karmaşık bir veri yapısını eşlemelerine olanak tanıyan aynı türde düğümlere sahip olabilir.
API Response Field Configuration
Конфигурация API Response Field
API Yanıt Alanı Yapılandırması
Properties
Свойства
Özellikleri
- codeName: The
codeName
needs to be the exact name of the property held in the response JSON object.
- codeName: сodeName должен быть точным именем свойства, содержащегося в объекте JSON ответа.
- codeName:
codeName
, yanıt JSON nesnesinde tutulan özelliğin tam adı olmalıdır.
Note: For the first object, since it is a special case, we usually use the codeName of rootObject.
Note: Для первого объекта, поскольку это особый случай, мы обычно используем codeName rootObject.
Note: Not: İlk nesne için, özel bir durum olduğundan, genellikle rootObject'in codeName'ini kullanırız.
- fieldType: This property declares if the data is a number, string, object, or array.
- fieldType: Это свойство объявляет, являются ли данные числом, строкой, объектом или массивом.
- fieldType: Bu özellik, verilerin bir sayı, dize, nesne veya dizi olup olmadığını bildirir.
- description: The API Map is expected to be used not only by the user who created, but once contributed as a Plugin, by all other users. This property is useful to store the description of this field as it was written at the API Server documentation, to avoid other users to go and look for it.
- description: Ожидается, что API Map будет использоваться не только пользователем, который создал, но и когда-то внесен в качестве подключаемого модуля, всеми другими пользователями. Это свойство полезно для хранения описания этого поля, как оно было написано в документации по серверу API, чтобы другие пользователи не пошли его искать.
- description: API Haritasının ( API Map ) yalnızca oluşturan kullanıcı tarafından değil, bir kez Eklenti olarak katkıda bulunan diğer tüm kullanıcılar tarafından kullanılması beklenir. Bu özellik, diğer kullanıcıların gidip onu aramasını önlemek için API Sunucusu ( API Server ) belgelerinde yazıldığı gibi bu alanın açıklamasını saklamak için kullanışlıdır.
Possible Values for Field Type Property
Возможные значения для свойства Field Type
Alan Türü Özelliği için Olası Değerler
This property is very important and needs to be defined very well. This property defines the structure of the response data structure and needs to be very precise. It's possible values are:
Это свойство очень важно и должно быть очень хорошо определено. Это свойство определяет структуру структуры данных ответа и должно быть очень точным. Возможные значения:
Bu özellik çok önemlidir ve çok iyi tanımlanması gerekir. Bu özellik, yanıt veri yapısının yapısını tanımlar ve çok kesin olması gerekir. Olası değerler şunlardır:
- number: Any type of numbers fall into this category, including dates timestamps in numbers.
- number: В эту категорию попадают любые типы чисел, включая даты и временные метки (timestamp) в числах.
- number: Sayılardaki tarih zaman damgaları da dahil olmak üzere her tür sayı bu kategoriye girer.
- string: Any strings falls into this category, including dates in string format.
- string: В эту категорию попадают любые строки, включая даты в строковом формате.
- string: Dize biçimindeki tarihler de dahil olmak üzere tüm dizeler bu kategoriye girer.
- object: Use this value when you find that the field holds a JSON object enclosed in { and }
- object: Используйте это значение, если вы обнаружите, что поле содержит объект JSON, заключенный в { }
- object: Alanın { and } içinde bir JSON nesnesi tuttuğunu bulduğunuzda bu değeri kullanın.
- array: Use this type when the value of the field is a JSON array enclosed in [ and ]
- array: Используйте этот тип, если значение поля представляет собой массив JSON, заключенный в [ ]
- array: Alanın değeri, [ and ] içine alınmış bir JSON dizisi olduğunda bu türü kullanın.
Initial Values
These are the Initial Values for API Response Field configuration:
{
"codeName": "",
"fieldType": "",
"description": ""
}
Examples
This is a list of properties featured by the API Response Field configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
API Response Field Menu
The API Response Field 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 Add API Response Field menu item has the following properties:
- action: Add UI Object
- label: Add API Response Field
- relatedUiObject: API Response Field
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
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 Response Field already has the required child type that the menu item may add, and only that child is allowed for that case.
API Response Field Children
The API Response Field node has the following childrenNodesProperties:
The Api Response Fields node property features the following properties:
- name:
apiResponseFields
- type: array
- childType: API Response Field
- autoAdd: false
API Response Field Attaching Rules
The following are the Node Attaching Rules that govern the attachment of API Response Field with other nodes:
Compatible Types: