Jump to

• Request
• Response

Retrieve a rule configuration.

get

/gsadmin/v1/{appName}/content/rankingRules/{Rule}

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

• Rule: string
  Specifies the name of rule.
• appName: string
  Specifies the name of your application. For example, "cloud".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A rule configuration.

Body ()

Root Schema : RankingRule

Match All

Show Source

• object BaseECR
• object RankingRule-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"
                                                }
                                            },
                                            "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 : BaseECR

Type: object

Show Source

• ecr:createDate(optional): 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(optional): 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(optional): 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 : RankingRule-allOf[1]

Type: object

Configuration for dynamic ranking.

Show Source

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

  Allowed Values: [ "content-item" ]
• priority: integer(int32)
• triggers: array triggers
• workflowState(optional): 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"
                                        }
                                    },
                                    "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 : contentItem

Type: object

Show Source

• @type(optional): string
  Default Value: RankModuleBoostBuryBlend
• blendFactors(optional): array blendFactors
• boostStrata(optional): array boostStrata
  Array of products to boost. The order should be respected
• buryStrata(optional): array buryStrata
  Array of products to Bury. The order should be respected
• showAll(optional): 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"
                                }
                            },
                            "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"
                        }
                    },
                    "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: string
  Default Value: DimValBlendFactorGroup

  Allowed Values: [ "PropertyBlendFactor", "DateBlendFactor", "DimValBlendFactorGroup" ]
• attribute: string
• items(optional): 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"
                    }
                },
                "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"
            }
        },
        "required":[
            "@type",
            "dvalID"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• @type: string
  Default Value: DimValBlendFactor

  Allowed Values: [ "DimValBlendFactor" ]
• dvalID: string
  Example: 12345

{
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "default":"DimValBlendFactor",
            "enum":[
                "DimValBlendFactor"
            ]
        },
        "dvalID":{
            "type":"string",
            "example":"12345"
        }
    },
    "required":[
        "@type",
        "dvalID"
    ]
}

Nested Schema : PropertyStrata

Type: object

Show Source

• @type(optional): string
  Allowed Values: [ "PropertyStrata" ]

  Strata type

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

  Example: product.respositoryId
• value(optional): 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(optional): 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(optional): array ecr:expanded:dimvals
• exactLocation(optional): boolean
• matchmode(optional): string
  Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL.
• searchTerms(optional): 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"
    }
}

Nested Schema : ExpandedDimVal

Expanded dimval array corresponding to dimvalid or dimvalIds array

Match All

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

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(optional): string
  Example: US Catalog
• dvalID(optional): 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(optional): string
  Example: 12345
• dimensionName(optional): 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(optional): 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