Export Dynamic Attributes

Get Dynamic Attributes

The dynamic 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>)/dynamicAttributes. The response is a JSON with all dynamic attributes.

{
   "@odata.context": "http://betlpznb207:7268/BC/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/dynamicAttributes",
   "value":    [
            {
         "@odata.etag": "W/\"JzIwOzE0NTM3OTExMzI0NTY1MDMzMzIwMTswMDsn\"",
         "systemId": "0364685c-a3dd-ec11-90fe-cb62da85b82a",
         "dynamicAttributeCode": "LSF",
         "filter": false,
         "show": false
      },
            {
         "@odata.etag": "W/\"JzIwOzE0NTM3NjYwMjc3NzgwNzEyOTIxMTswMDsn\"",
         "systemId": "5e664fa5-a3dd-ec11-90fe-cb62da85b82a",
         "dynamicAttributeCode": "PASSFORM",
         "filter": false,
         "show": false
      }
   ]
}

The fields are documented in the following table.

field	data type	content
`systemId`	GUID	distinct identifier for a dynamic attribute record
`dynamicAttributeCode`	Text[10]	human-readable distinct identifier for a dynamic attribute record
`filter`	boolean	filter flag
`show`	boolean	show flag

How the fields filter and hidden are used must be discussed individually.

Get Dynamic Attribute Descriptions

The dynamic 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>)/dynamicAttributeDescriptions/$filter=webshopChannelCode eq '<webshop channel code>' and dynamicAttributeSystemId eq {<dynamic attribute system id>}. The response is a JSON with all dynamic attribute descriptions for the given dynamic attribute and webshop channel. The filters for webshop channel and dynamic 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>)/dynamicAttributeDescriptions",
   "value":    [
            {
         "@odata.etag": "W/\"JzE5OzQ2NjQxMDU4MDgwNjY1NDgwNzAxOzAwOyc=\"",
         "systemId": "71fa9ae9-85dd-ec11-90fe-cb62da85b82a",
         "webshopChannelCode": "B2C",
         "dynamicAttributeSystemId": "{0364685C-A3DD-EC11-90FE-CB62DA85B82A}",
         "language": "DEU",
         "text": "Lichtschutzfaktor"
      },
            {
         "@odata.etag": "W/\"JzE5OzQ2NjMyNDgxMTMyNTUyNTk5NzYxOzAwOyc=\"",
         "systemId": "72fa9ae9-85dd-ec11-90fe-cb62da85b82a",
         "webshopChannelCode": "B2C",
         "dynamicAttributeSystemId": "{0364685C-A3DD-EC11-90FE-CB62DA85B82A}",
         "language": "ENU",
         "text": "sun protection factor"
      }
   ]
}

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
`dynamicAttributeSystemId`	GUID	the system id of the dynamic attribute
`language`	Text[10]	human-readable distinct language identifier of the language
`text`	Text	The translation of the dynamic attribute description

Get dynamic attribute values

The values a dynamic attribute can have can be accessed via the url GET http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/companies(<company system id>)/dynamicAttributeValue/$filter=dynamicAttributeCode eq '<dynamic attribute code>. The response is a JSON with all possible for the given dynamic attribute and webshop channel. The filter on dynamicAttributeCode ist not mandatory. It is possible to get the attribute values of more than one dyanmic attribute with a single call.

{
   "@odata.context": "http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/dynamicAttributeValues",
   "value":    [
            {
         "@odata.etag": "W/\"JzIwOzExMjQ2MDY3OTUwNDY2Njc5MTc4MTswMDsn\"",
         "systemId": "75f764ae-a3dd-ec11-90fe-cb62da85b82a",
         "dynamicAttributeCode": "LSF",
         "dynamicAttributeValueCode": "10"
      },
            {
         "@odata.etag": "W/\"JzIwOzExMjQ2MDY2MjM0MzQwMzE3NzU3MTswMDsn\"",
         "systemId": "6cbef2b5-a3dd-ec11-90fe-cb62da85b82a",
         "dynamicAttributeCode": "LSF",
         "dynamicAttributeValueCode": "20"
      },
            {
         "@odata.etag": "W/\"JzIwOzExMjQ2MDY2MzAzNTk3NzEzOTgwMTswMDsn\"",
         "systemId": "6dbef2b5-a3dd-ec11-90fe-cb62da85b82a",
         "dynamicAttributeCode": "LSF",
         "dynamicAttributeValueCode": "30"
      }
   ]
}

The fields are documented in the following table.

field	data type	content
`systemId`	GUID	distinct identifier for a dynamic attribute value
`dynamicAttributeCode`	Text[10]	human-readable distinct identifier for a dynamic attribute record
`dynamicAttributeValueCode`	Text[10]	human-readable identifier for a dynamic attribute value, this field is guaranteed to be distinct per dynamic attrribute

Get dynamic attribute value descriptions

The dynamic attribute value 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>)/dynamicAttributeValueDescriptions/$filter=webshopChannelCode eq '<webshop channel code>' and dynamicAttributeValueSystemId eq {<dynamic attribute system id>}. The response is a JSON with all dynamic attribute value descriptions for the given dynamic attribute value and webshop channel. The filters for webshop channel and dynamic attribute value system id are mandatory.

{
   "@odata.context": "http://<server name>:<odata port>/<service tier name>/api/BEterna/Export/v2.0/$metadata#companies(<company system id>)/dynamicAttributeValueDescriptions",
   "value":    [
            {
         "@odata.etag": "W/\"JzE5OzQ2NjQwOTI2NTY0MDM4NDY5OTYxOzAwOyc=\"",
         "systemId": "71fa9ae9-85dd-ec11-90fe-cb62da85b82a",
         "webshopChannelCode": "B2C",
         "dynamicAttributeValueSystemId": "{<dynamic attribute value system id>}",
         "language": "DEU",
         "text": "fällt zu groß aus"
      },
            {
         "@odata.etag": "W/\"JzE5OzQ2NjMyMzQ5NjI1MjE5NjIxMzYxOzAwOyc=\"",
         "systemId": "72fa9ae9-85dd-ec11-90fe-cb62da85b82a",
         "webshopChannelCode": "B2C",
         "dynamicAttributeValueSystemId": "{<dynamic attribute value system id>}",
         "language": "ENU",
         "text": "size is larger than expected"
      }
   ]
}

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
`dynamicAttributeValueSystemId`	GUID	the system id of the dynamic attribute value
`language`	Text[10]	human-readable distinct language identifier of the language
`text`	Text	The translation of the dynamic attribute value description