Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
property

Query Property Value Descriptions

Query all descriptions for a specific property value

get/v2/properties/{propertyId}/values/{propertyValueId}/descriptions

Path parameters

propertyIdstring uuid required
Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the property.

propertyValueIdstring uuid required
Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the property value.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

The requested property value descriptions.

propertyValueIdstring uuid
namestring

The property value name in the given language.

descriptionstring

The property value description in the given language.

seoPathstring

The SEO path in the given language.

seoMetaDescriptionstring

The SEO metadescription in the given language.

seoTitleTagstring

The title tag (SEO) in the given language.

seoMetaKeywordsstring

The meta keywords in the given language.

languageIsostring

The ISO code of the language of the description.

Example response

[
  {
    "propertyValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]