The free text attributes can be accessed via the url GET http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/companies(<company system id>)/freeTextAttributes. The response is a JSON with all free text attributes.
{
"@odata.context": "http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/freeTextAttributes",
"value": [
{
"@odata.etag": "W/\"JzE5OzYwMjY4NzkwMjEzMTAyNzg1NDcxOzAwOyc=\"",
"systemId": "3273407f-8e02-ed11-be50-bbe07c808f1d",
"code": "FEATURES"
},
{
"@odata.etag": "W/\"JzE5OzYwMjY4NzkwMTk1NDYzOTgxNTUxOzAwOyc=\"",
"systemId": "3373407f-8e02-ed11-be50-bbe07c808f1d",
"code": "MEASURES"
}
]
}
The fields are documented in the following table.
| field | data type | content |
|---|---|---|
systemId |
GUID | distinct identifier for an free text attribute record |
code |
Code[10] | the code of the free text attribute |
The free text attribute descriptions can be accessed via the url GET http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/companies(<company system id>)/freeTextAttributeDescriptions?$filter=webshopChannelCode eq '<webshop-channel-code>' and freeTextAttributeSystemId eq '<free-text-attribute-system-id>'. The response is a JSON with all descriptions of free text attribute. Filters for webshop channel code and free text attribute system id are mandatory.
{
"@odata.context": "http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/freeTextAttributeDescriptions",
"value": [
{
"@odata.etag": "W/\"JzE5OzQ2NjQwMDQzNDU2NDg2MjA1OTgxOzAwOyc=\"",
"systemId": "16daa938-9302-ed11-be50-bbe07c808f1d",
"webshopChannelCode": "B2B",
"freeTextAttributeSystemId": "{3273407F-8E02-ED11-BE50-BBE07C808F1D}",
"language": "DE",
"text": "Vorteile"
},
{
"@odata.etag": "W/\"JzE5OzQ2MTc1OTEyMzY2Njc3MDk4OTExOzAwOyc=\"",
"systemId": "b4821b8b-9302-ed11-be50-bbe07c808f1d",
"webshopChannelCode": "B2B",
"freeTextAttributeSystemId": "{3273407F-8E02-ED11-BE50-BBE07C808F1D}",
"language": "ENU",
"text": "Features"
},
{
"@odata.etag": "W/\"JzE5OzQ2MTc4NzY5NjEwMzcxMjI4NjMxOzAwOyc=\"",
"systemId": "b5821b8b-9302-ed11-be50-bbe07c808f1d",
"webshopChannelCode": "B2B",
"freeTextAttributeSystemId": "{3273407F-8E02-ED11-BE50-BBE07C808F1D}",
"language": "SRP",
"text": "Prednosti"
}
]
}
The fields are documented in the following table.
| field | data type | content |
|---|---|---|
systemId |
GUID | distinct identifier for a language assigned to a webshop channel |
webshopChannelCode |
Text[20] | the webshop channel |
freeTextAttributeSystemId |
GUID | the system id of the free text attribute |
language |
Code[20] | human-readable distinct language identifier of the language |
text |
Text | The translation of the free text attribute description |