Jump to

• Request
• Response

View all the children of a dimension value.

get

/gsadmin/v1/{appName}/dimvals/{dimValKey}/children

Displays a list of all the child dimension values of the dimension value specified by {dimValKey}

Request

Supported Media Types

• application/json

Path Parameters

• appName(required): string
  Specifies the name of your application. For example, "cloud".
• dimValKey(required): string
  Specifies the dimval id you are interested For example, 12345. Or in the special case of a dimension root the attribute name can be used. For example 'product.category'.

Query Parameters

• locale: string
  locale parameter to overwrite X-CCAsset-Language or application default
• maxDepth: integer
  Specify the depth of children to be returned. In order to see all children specify -1.

Header Parameters

• X-CCAsset-Language: string
  Asset Locale value sent by all cloud requests. example: 'en'

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of child dimension values.

Body ()

Root Schema : ExpandedDimValList

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExpandedDimVal"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ExpandedDimVal
  Expanded dimval array corresponding to dimvalid or dimvalIds array

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

Nested Schema : ExpandedDimVal

Expanded dimval array corresponding to dimvalid or dimvalIds array

Match All

Expanded dimval array corresponding to dimvalid or dimvalIds array

Expanded dimval array corresponding to dimvalid or dimvalIds array

Show Source

• allOf DimVal
  Expanded dimval array corresponding to dimvalid or dimvalIds array
• object ExpandedDimVal-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DimVal"
        },
        {
            "properties":{
                "ancestors":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/BaseDimVal"
                    }
                }
            }
        }
    ],
    "description":"Expanded dimval array corresponding to dimvalid or dimvalIds array"
}

Nested Schema : DimVal

Expanded dimval array corresponding to dimvalid or dimvalIds array

Match All

Expanded dimval array corresponding to dimvalid or dimvalIds array

Expanded dimval array corresponding to dimvalid or dimvalIds array

Show Source

• object BaseDimVal
• object DimVal-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/BaseDimVal"
        },
        {
            "properties":{
                "dimensionName":{
                    "type":"string",
                    "example":"product.category"
                },
                "dimensionId":{
                    "type":"string",
                    "example":"12345"
                }
            }
        }
    ],
    "description":"Expanded dimval array corresponding to dimvalid or dimvalIds array"
}

Nested Schema : BaseDimVal

Type: object

Show Source

• displayName: string
  Example: US Catalog
• dvalID: string
  Example: 235122

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "example":"US Catalog"
        },
        "dvalID":{
            "type":"string",
            "example":"235122"
        }
    }
}

Nested Schema : DimVal-allOf[1]

Type: object

Show Source

• dimensionId: string
  Example: 12345
• dimensionName: string
  Example: product.category

{
    "properties":{
        "dimensionName":{
            "type":"string",
            "example":"product.category"
        },
        "dimensionId":{
            "type":"string",
            "example":"12345"
        }
    }
}

Nested Schema : ExpandedDimVal-allOf[1]

Type: object

Show Source

• ancestors: array ancestors

{
    "properties":{
        "ancestors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BaseDimVal"
            }
        }
    }
}

Nested Schema : ancestors

Type: array

Show Source

• Array of: object BaseDimVal

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

Back to Top