Jump to

• Request
• Response
• Examples

getFacetList

get

/gsadmin/v1/{appName}/content/facets/{facetListName}

View a facet list.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• facetListName: string
  Specifies the name of the facet list. For example, "default".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A facet list that defines the explicit order of facets at a given location.

Body ()

Root Schema : FacetList

Type: object

Represents a list of facet value records.

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FacetValue"
            }
        }
    },
    "description":"Represents a list of facet value records.",
    "example":{
        "items":[
            {
                "key":"Acme",
                "displayOrder":"1",
                "x_imageUrl":"acme.png",
                "x_description":"Acme is a great brand"
            },
            {
                "key":"Value Brand",
                "displayOrder":"2",
                "x_imageUrl":"valueBrand.png",
                "x_description":"Value Brand is a great brand"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "key":"Acme",
            "displayOrder":"1",
            "x_imageUrl":"acme.png",
            "x_description":"Acme is a great brand"
        },
        {
            "key":"Value Brand",
            "displayOrder":"2",
            "x_imageUrl":"valueBrand.png",
            "x_description":"Value Brand is a great brand"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object FacetValue
  Represents a facet value record from a facet record collection. This can be used to specify displayOrder and custom properties for a facet value. Custom properties must contain an underscore character. For example 'x_imageUrl' might be created to associate an image with a facet value.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FacetValue"
    }
}

Nested Schema : FacetValue

Type: object

Represents a facet value record from a facet record collection. This can be used to specify displayOrder and custom properties for a facet value. Custom properties must contain an underscore character. For example 'x_imageUrl' might be created to associate an image with a facet value.

Show Source

• displayName(optional): string
  Optionally specifies a display name. If no 'displayName' is configured, the 'key' is used. This is useful if you want to match data records on one value, but display another.

  Example: Acme Brand
• displayOrder(optional): string
  Specifies the order display when the given facets is sorted by 'displayOrder' within 'displayConfig' under /attributes

  Example: 1
• key(optional): string
  This is used when matching data records during indexing.

  Example: Acme
• locale(optional): string
  If this attribute has a context=locale under /attributes, then a locale code must be specified to match data records. To view the list of configured locale codes, you can GET /gsadmin/v1/cloud/searchIndexConfig and examine the union of 'defaultLocale' plus 'locales'.

  Example: en
• lowerBound(optional): string
  Specifies the lower bound for a range facet value. The facet configuration /gsadmin/v1/cloud/attributes/system/{attribute name} need to specify a 'rangeComparisonType' to configure a facet as a range facet. The values that you POST to /gsdata are wrapped in quotes, but the actual value inside must match the 'rangeComparisonType'. The configured lower bound is inclusive.

  Example: 4.500
• priceGroup(optional): string
  If this attribute has a context=priceGroup under /attributes, then a priceGroup name must be specified to match data records. To view the list of currently configured priceGroup values, you can GET /gsadmin/v1/cloud/attributeContexts/priceGroup

  Example: defaultPriceGroup
• record.action(optional): string
  Allowed Values: [ "UPSERT", "DELETE" ]

  Instructs the system what to do with this record. If not specified defaults to upsert. Typically, you would only ever specify DELETE to delete an existing facet value record.

  Example:
• upperBound(optional): string
  Specifies the upper bound for a range facet value. The facet configuration /gsadmin/v1/cloud/attributes/system/{attribute name} need to specify a 'rangeComparisonType' to configure a facet as a range facet. The values that you POST to /gsdata are wrapped in quotes, but the actual value inside must match the 'rangeComparisonType'. The configured upper bound is not inclusive.

  Example: 5.00

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "example":"Acme",
            "description":"This is used when matching data records during indexing.  "
        },
        "locale":{
            "type":"string",
            "example":"en",
            "description":"If this attribute has a context=locale under /attributes, then a locale code must be specified to match data records. To view the list of configured locale codes, you can GET /gsadmin/v1/cloud/searchIndexConfig and examine the union of 'defaultLocale' plus 'locales'."
        },
        "priceGroup":{
            "type":"string",
            "example":"defaultPriceGroup",
            "description":"If this attribute has a context=priceGroup under /attributes, then a priceGroup name must be specified to match data records. To view the list of currently configured priceGroup values, you can GET /gsadmin/v1/cloud/attributeContexts/priceGroup"
        },
        "displayOrder":{
            "type":"string",
            "example":"1",
            "description":"Specifies the order display when the given facets is sorted by 'displayOrder' within 'displayConfig' under /attributes "
        },
        "displayName":{
            "type":"string",
            "example":"Acme Brand",
            "description":"Optionally specifies a display name.  If no 'displayName' is configured, the 'key' is used.  This is useful if you want to match data records on one value, but display another."
        },
        "upperBound":{
            "type":"string",
            "example":"5.00",
            "description":"Specifies the upper bound for a range facet value.  The facet configuration  /gsadmin/v1/cloud/attributes/system/{attribute name} need to specify a 'rangeComparisonType' to configure a facet as a range facet.  The values that you POST to /gsdata are wrapped in quotes, but the actual value inside must match the 'rangeComparisonType'.  The configured upper bound is not inclusive."
        },
        "lowerBound":{
            "type":"string",
            "example":"4.500",
            "description":"Specifies the lower bound for a range facet value.  The facet configuration  /gsadmin/v1/cloud/attributes/system/{attribute name} need to specify a 'rangeComparisonType' to configure a facet as a range facet.  The values that you POST to /gsdata are wrapped in quotes, but the actual value inside must match the 'rangeComparisonType'. The configured lower bound is inclusive."
        },
        "record.action":{
            "type":"string",
            "example":" ",
            "description":"Instructs the system what to do with this record. If not specified defaults to upsert. Typically, you would only ever specify DELETE to delete an existing facet value record.",
            "enum":[
                "UPSERT",
                "DELETE"
            ]
        }
    },
    "description":"Represents a facet value record from a facet record collection. This can be used to specify displayOrder and custom properties for a facet value. Custom properties must contain an underscore character.  For example 'x_imageUrl' might be created to associate an image with a facet value."
}

Back to Top

Examples

The following example shows how to view a facet list:

curl -H "Authorization:Bearer <token>" -X GET http://<host>:<port>/gsadmin/v1/cloud/content/facets/default

Back to Top