Jump to

• Request
• Response

View list of ranking rules with expanded information.

get

/gsadmin/v1/{appName}/content/rankingRules.ccadminui.json

Displays a list of ranking rules where the dimension values have been expanded in order to return their display names.

Request

Supported Media Types

• application/json

Path Parameters

• appName(required): string
  Specifies the name of your application. For example, "cloud".

Query Parameters

• fields: string
  Comma delimited list of the fields to include for each ranking rule in the list. Meta data is always included.

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of ranking rules with the contents included .

Body ()

Root Schema : ListOfRankingRules.ccadmin

Match All

Show Source

• object BaseECR
• object ListOfRankingRules.ccadmin-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/BaseECR"
        },
        {
            "properties":{
                "ecr:type":{
                    "type":"string",
                    "default":"content-collection-folder",
                    "enum":[
                        "content-collection-folder"
                    ]
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ListedRule.ccadmin"
                    }
                }
            }
        }
    ]
}

Nested Schema : BaseECR

Type: object

Show Source

• ecr:createDate: string
  Date this object was first created. Found in responses. Ignored in POST/PUT payloads.

  Example: 2018-01-01T13:41:03.858-04:00
• ecr:lastModified: string
  Date this object was last modified. Found in responses. Ignored in POST/PUT payloads.

  Example: 2018-01-01T13:41:03.858-04:00
• ecr:lastModifiedBy: string
  User who last modified this object. Found in responses. Ignored in POST/PUT payloads.

  Example: admin

{
    "type":"object",
    "properties":{
        "ecr:createDate":{
            "type":"string",
            "example":"2018-01-01T13:41:03.858-04:00",
            "description":"Date this object was first created. Found in responses. Ignored in POST/PUT payloads."
        },
        "ecr:lastModified":{
            "type":"string",
            "example":"2018-01-01T13:41:03.858-04:00",
            "description":"Date this object was last modified. Found in responses. Ignored in POST/PUT payloads."
        },
        "ecr:lastModifiedBy":{
            "type":"string",
            "example":"admin",
            "description":"User who last modified this object. Found in responses. Ignored in POST/PUT payloads."
        }
    }
}

Nested Schema : ListOfRankingRules.ccadmin-allOf[1]

Type: object

Show Source

• ecr:type: string
  Default Value: content-collection-folder

  Allowed Values: [ "content-collection-folder" ]
• items: array items

{
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"content-collection-folder",
            "enum":[
                "content-collection-folder"
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ListedRule.ccadmin"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ListedRule.ccadmin

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ListedRule.ccadmin"
    }
}

Nested Schema : ListedRule.ccadmin

Match All

Configuration for dynamic ranking.

Show Source

• allOf Rule.ccadmin
• object ListedRule.ccadmin-allOf[1]
  Configuration for dynamic ranking.

{
    "allOf":[
        {
            "$ref":"#/definitions/Rule.ccadmin"
        },
        {
            "properties":{
                "ecr:name":{
                    "type":"string",
                    "example":"rankingRuleName"
                }
            },
            "description":"Configuration for dynamic ranking."
        }
    ]
}

Nested Schema : Rule.ccadmin

Match All

Configuration for dynamic ranking.

Show Source

• object BaseECR
• object Rule.ccadmin-allOf[1]
  Configuration for dynamic ranking.

{
    "allOf":[
        {
            "$ref":"#/definitions/BaseECR"
        },
        {
            "required":[
                "contentItem",
                "ecr:type",
                "priority",
                "triggers"
            ],
            "properties":{
                "ecr:name":{
                    "type":"string",
                    "example":"rankingRuleName"
                },
                "ecr:type":{
                    "type":"string",
                    "default":"content-item",
                    "enum":[
                        "content-item"
                    ]
                },
                "contentItem":{
                    "type":"object",
                    "properties":{
                        "buryStrata":{
                            "type":"array",
                            "description":"Array of products to Bury. The order should be respected",
                            "items":{
                                "$ref":"#/definitions/PropertyStrata"
                            }
                        },
                        "showAll":{
                            "type":"boolean"
                        },
                        "blendFactors":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "@type":{
                                        "type":"string",
                                        "default":"DimValBlendFactorGroup",
                                        "enum":[
                                            "PropertyBlendFactor",
                                            "DateBlendFactor",
                                            "DimValBlendFactorGroup"
                                        ]
                                    },
                                    "attribute":{
                                        "type":"string"
                                    },
                                    "items":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "@type":{
                                                    "type":"string",
                                                    "default":"DimValBlendFactor",
                                                    "enum":[
                                                        "DimValBlendFactor"
                                                    ]
                                                },
                                                "dvalID":{
                                                    "type":"string",
                                                    "example":"12345"
                                                },
                                                "ecr:x-expand:dimvals":{
                                                    "type":"array",
                                                    "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
                                                    "items":{
                                                        "$ref":"#/definitions/ExpandedDimVal"
                                                    }
                                                }
                                            },
                                            "required":[
                                                "@type",
                                                "dvalID"
                                            ]
                                        }
                                    }
                                },
                                "required":[
                                    "@type",
                                    "attribute"
                                ]
                            }
                        },
                        "boostStrata":{
                            "type":"array",
                            "description":"Array of products to boost. The order should be respected",
                            "items":{
                                "$ref":"#/definitions/PropertyStrata"
                            }
                        },
                        "@type":{
                            "type":"string",
                            "default":"RankModuleBoostBuryBlend"
                        }
                    }
                },
                "priority":{
                    "type":"integer",
                    "format":"int32"
                },
                "triggers":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "ecr:expanded:dimvals":{
                                "type":"array",
                                "items":{
                                    "$ref":"#/definitions/ExpandedDimVal"
                                }
                            },
                            "exactLocation":{
                                "type":"boolean"
                            },
                            "searchTerms":{
                                "type":"string",
                                "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
                            },
                            "matchmode":{
                                "type":"string",
                                "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
                            },
                            "dvalIDs":{
                                "type":"array",
                                "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
                                "items":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                },
                "workflowState":{
                    "type":"string"
                }
            },
            "description":"Configuration for dynamic ranking."
        }
    ]
}

Nested Schema : Rule.ccadmin-allOf[1]

Type: object

Configuration for dynamic ranking.

Show Source

• contentItem(required): object contentItem
• ecr:name: string
  Example: rankingRuleName
• ecr:type(required): string
  Default Value: content-item

  Allowed Values: [ "content-item" ]
• priority(required): integer(int32)
• triggers(required): array triggers
• workflowState: string

{
    "required":[
        "contentItem",
        "ecr:type",
        "priority",
        "triggers"
    ],
    "properties":{
        "ecr:name":{
            "type":"string",
            "example":"rankingRuleName"
        },
        "ecr:type":{
            "type":"string",
            "default":"content-item",
            "enum":[
                "content-item"
            ]
        },
        "contentItem":{
            "type":"object",
            "properties":{
                "buryStrata":{
                    "type":"array",
                    "description":"Array of products to Bury. The order should be respected",
                    "items":{
                        "$ref":"#/definitions/PropertyStrata"
                    }
                },
                "showAll":{
                    "type":"boolean"
                },
                "blendFactors":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "@type":{
                                "type":"string",
                                "default":"DimValBlendFactorGroup",
                                "enum":[
                                    "PropertyBlendFactor",
                                    "DateBlendFactor",
                                    "DimValBlendFactorGroup"
                                ]
                            },
                            "attribute":{
                                "type":"string"
                            },
                            "items":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "@type":{
                                            "type":"string",
                                            "default":"DimValBlendFactor",
                                            "enum":[
                                                "DimValBlendFactor"
                                            ]
                                        },
                                        "dvalID":{
                                            "type":"string",
                                            "example":"12345"
                                        },
                                        "ecr:x-expand:dimvals":{
                                            "type":"array",
                                            "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
                                            "items":{
                                                "$ref":"#/definitions/ExpandedDimVal"
                                            }
                                        }
                                    },
                                    "required":[
                                        "@type",
                                        "dvalID"
                                    ]
                                }
                            }
                        },
                        "required":[
                            "@type",
                            "attribute"
                        ]
                    }
                },
                "boostStrata":{
                    "type":"array",
                    "description":"Array of products to boost. The order should be respected",
                    "items":{
                        "$ref":"#/definitions/PropertyStrata"
                    }
                },
                "@type":{
                    "type":"string",
                    "default":"RankModuleBoostBuryBlend"
                }
            }
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "triggers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ecr:expanded:dimvals":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/ExpandedDimVal"
                        }
                    },
                    "exactLocation":{
                        "type":"boolean"
                    },
                    "searchTerms":{
                        "type":"string",
                        "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
                    },
                    "matchmode":{
                        "type":"string",
                        "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
                    },
                    "dvalIDs":{
                        "type":"array",
                        "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        },
        "workflowState":{
            "type":"string"
        }
    },
    "description":"Configuration for dynamic ranking."
}

Nested Schema : ListedRule.ccadmin-allOf[1]

Type: object

Configuration for dynamic ranking.

Show Source

• ecr:name: string
  Example: rankingRuleName

{
    "properties":{
        "ecr:name":{
            "type":"string",
            "example":"rankingRuleName"
        }
    },
    "description":"Configuration for dynamic ranking."
}

Nested Schema : contentItem

Type: object

Show Source

• @type: string
  Default Value: RankModuleBoostBuryBlend
• blendFactors: array blendFactors
• boostStrata: array boostStrata
  Array of products to boost. The order should be respected
• buryStrata: array buryStrata
  Array of products to Bury. The order should be respected
• showAll: boolean

{
    "type":"object",
    "properties":{
        "buryStrata":{
            "type":"array",
            "description":"Array of products to Bury. The order should be respected",
            "items":{
                "$ref":"#/definitions/PropertyStrata"
            }
        },
        "showAll":{
            "type":"boolean"
        },
        "blendFactors":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "@type":{
                        "type":"string",
                        "default":"DimValBlendFactorGroup",
                        "enum":[
                            "PropertyBlendFactor",
                            "DateBlendFactor",
                            "DimValBlendFactorGroup"
                        ]
                    },
                    "attribute":{
                        "type":"string"
                    },
                    "items":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "@type":{
                                    "type":"string",
                                    "default":"DimValBlendFactor",
                                    "enum":[
                                        "DimValBlendFactor"
                                    ]
                                },
                                "dvalID":{
                                    "type":"string",
                                    "example":"12345"
                                },
                                "ecr:x-expand:dimvals":{
                                    "type":"array",
                                    "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
                                    "items":{
                                        "$ref":"#/definitions/ExpandedDimVal"
                                    }
                                }
                            },
                            "required":[
                                "@type",
                                "dvalID"
                            ]
                        }
                    }
                },
                "required":[
                    "@type",
                    "attribute"
                ]
            }
        },
        "boostStrata":{
            "type":"array",
            "description":"Array of products to boost. The order should be respected",
            "items":{
                "$ref":"#/definitions/PropertyStrata"
            }
        },
        "@type":{
            "type":"string",
            "default":"RankModuleBoostBuryBlend"
        }
    }
}

Nested Schema : triggers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ecr:expanded:dimvals":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ExpandedDimVal"
                }
            },
            "exactLocation":{
                "type":"boolean"
            },
            "searchTerms":{
                "type":"string",
                "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
            },
            "matchmode":{
                "type":"string",
                "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
            },
            "dvalIDs":{
                "type":"array",
                "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : blendFactors

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "@type":{
                "type":"string",
                "default":"DimValBlendFactorGroup",
                "enum":[
                    "PropertyBlendFactor",
                    "DateBlendFactor",
                    "DimValBlendFactorGroup"
                ]
            },
            "attribute":{
                "type":"string"
            },
            "items":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "@type":{
                            "type":"string",
                            "default":"DimValBlendFactor",
                            "enum":[
                                "DimValBlendFactor"
                            ]
                        },
                        "dvalID":{
                            "type":"string",
                            "example":"12345"
                        },
                        "ecr:x-expand:dimvals":{
                            "type":"array",
                            "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
                            "items":{
                                "$ref":"#/definitions/ExpandedDimVal"
                            }
                        }
                    },
                    "required":[
                        "@type",
                        "dvalID"
                    ]
                }
            }
        },
        "required":[
            "@type",
            "attribute"
        ]
    }
}

Nested Schema : boostStrata

Type: array

Array of products to boost. The order should be respected

Show Source

• Array of: object PropertyStrata

{
    "type":"array",
    "description":"Array of products to boost. The order should be respected",
    "items":{
        "$ref":"#/definitions/PropertyStrata"
    }
}

Nested Schema : buryStrata

Type: array

Array of products to Bury. The order should be respected

Show Source

• Array of: object PropertyStrata

{
    "type":"array",
    "description":"Array of products to Bury. The order should be respected",
    "items":{
        "$ref":"#/definitions/PropertyStrata"
    }
}

Nested Schema : items

Type: object

Show Source

• @type(required): string
  Default Value: DimValBlendFactorGroup

  Allowed Values: [ "PropertyBlendFactor", "DateBlendFactor", "DimValBlendFactorGroup" ]
• attribute(required): string
• items: array items

{
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "default":"DimValBlendFactorGroup",
            "enum":[
                "PropertyBlendFactor",
                "DateBlendFactor",
                "DimValBlendFactorGroup"
            ]
        },
        "attribute":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "@type":{
                        "type":"string",
                        "default":"DimValBlendFactor",
                        "enum":[
                            "DimValBlendFactor"
                        ]
                    },
                    "dvalID":{
                        "type":"string",
                        "example":"12345"
                    },
                    "ecr:x-expand:dimvals":{
                        "type":"array",
                        "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
                        "items":{
                            "$ref":"#/definitions/ExpandedDimVal"
                        }
                    }
                },
                "required":[
                    "@type",
                    "dvalID"
                ]
            }
        }
    },
    "required":[
        "@type",
        "attribute"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "@type":{
                "type":"string",
                "default":"DimValBlendFactor",
                "enum":[
                    "DimValBlendFactor"
                ]
            },
            "dvalID":{
                "type":"string",
                "example":"12345"
            },
            "ecr:x-expand:dimvals":{
                "type":"array",
                "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
                "items":{
                    "$ref":"#/definitions/ExpandedDimVal"
                }
            }
        },
        "required":[
            "@type",
            "dvalID"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• @type(required): string
  Default Value: DimValBlendFactor

  Allowed Values: [ "DimValBlendFactor" ]
• dvalID(required): string
  Example: 12345
• ecr:x-expand:dimvals: array ecr:x-expand:dimvals
  Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.

{
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "default":"DimValBlendFactor",
            "enum":[
                "DimValBlendFactor"
            ]
        },
        "dvalID":{
            "type":"string",
            "example":"12345"
        },
        "ecr:x-expand:dimvals":{
            "type":"array",
            "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
            "items":{
                "$ref":"#/definitions/ExpandedDimVal"
            }
        }
    },
    "required":[
        "@type",
        "dvalID"
    ]
}

Nested Schema : ecr:x-expand:dimvals

Type: array

Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.

Show Source

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

{
    "type":"array",
    "description":"Transient property that is only present when using the ccadminui selector. It is not meant to be included when using POST.",
    "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"
    }
}

Nested Schema : PropertyStrata

Type: object

Show Source

• @type: string
  Allowed Values: [ "PropertyStrata" ]

  Strata type

  Example: PropertyStrata
• attribute: string
  Attribute to match for property strata

  Example: product.respositoryId
• value: string
  value to match in attribute

  Example: 123456

{
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "example":"PropertyStrata",
            "description":"Strata type",
            "enum":[
                "PropertyStrata"
            ]
        },
        "attribute":{
            "type":"string",
            "example":"product.respositoryId",
            "description":"Attribute to match for property strata"
        },
        "value":{
            "type":"string",
            "example":"123456",
            "description":"value to match in attribute"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dvalIDs: array dvalIDs
  Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.
• ecr:expanded:dimvals: array ecr:expanded:dimvals
• exactLocation: boolean
• matchmode: string
  Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL.
• searchTerms: string
  Specifies the search terms based location in the storefront where the facet list is to be used.

{
    "type":"object",
    "properties":{
        "ecr:expanded:dimvals":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExpandedDimVal"
            }
        },
        "exactLocation":{
            "type":"boolean"
        },
        "searchTerms":{
            "type":"string",
            "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
        },
        "matchmode":{
            "type":"string",
            "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
        },
        "dvalIDs":{
            "type":"array",
            "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : dvalIDs

Type: array

Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : ecr:expanded:dimvals

Type: array

Show Source

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

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

Back to Top