attribute-elements

Get a list of values for an attribute label

Use this call to get a list of all values belonging to a specific attribute label.

An attribute can have different labels. That is, the attribute values can be displayed differently based on your preferences.

For example, you have the Day of Week attribute. When you choose a label for this attribute, you define how you want the attribute values (the week days) to be displayed:

with their full names: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday
with their shortened names: Sun, Mon, Tue, Wed, Thu, Fri, and Sat
as numbers from 1 to 7, where 1 is Sunday, 2 is Monday, and so on

In this example, for the label of full names, this call would return the values from Sunday to Saturday.

For more information about attribute labels and values, see Determine the Attribute Value ID.

get/gdc/md/{project_id}/obj/{label_id}/elements

Request

Base URL
https://secure.gooddata.com
Auth
none declared

Path parameters

project_idstring required

The ID of the project that the attribute belongs to.

label_idstring required

The ID of the attribute label whose values you want to list.

Query parameters

order'asc' | 'desc'

The order of sorting the returned values by their titles. Can be set to asc (ascending; default) or desc (descending). Cannot be used in the same call with orderKey (use either order or orderKey, not both).

orderKey'label' | 'pk'

The label property to sort the returned values by. Can be set to label (the values are sorted by their titles in ascending order; default) or pk (the values are sorted randomly). Set it to pk for attribute labels with high cardinality to prevent timing out when sorting the values. Cannot be used in the same call with order (use either order or orderKey, not both).

offsetnumber

The offset of the first record in the returned list.

limitnumber

The number of values returned on one page. The maximum is 10000.

Response

Example response

{
  "attributeElements": {
    "elements": [
      {
        "uri": "/gdc/md/{project_id}/obj/{attribute_id}/elements?id={value1_id}"
      }
    ],
    "elementsMeta": {
      "attribute": "/gdc/md/{project_id}/obj/{attribute_id}",
      "attributeDisplayForm": "/gdc/md/{project_id}/obj/{label_id}"
    },
    "paging": {
      "next": "/gdc/md/{project_id}/obj/{label_id}/elements"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.