Jump to

• Request
• Response

View list of ranking rules.

get

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

Displays a list of ranking rules.

Request

Supported Media Types

• application/json

Path Parameters

• appName(required): 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 list of ranking rules.

Body ()

Root Schema : ListOfRankingRules

Match All

Show Source

• object BaseECR
• object ListOfRankingRules-allOf[1]
  Additional Properties Allowed: ListedRule

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

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-allOf[1]

Type: object

Additional Properties Allowed

Show Source

• object ListedRule
  A rule configuration as displayed when getting as a list.

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"content-collection-folder",
            "enum":[
                "content-collection-folder"
            ]
        }
    },
    "additionalProperties":{
        "$ref":"#/definitions/ListedRule"
    }
}

Show Source

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

  Allowed Values: [ "content-collection-folder" ]

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"content-collection-folder",
            "enum":[
                "content-collection-folder"
            ]
        }
    },
    "additionalProperties":{
        "$ref":"#/definitions/ListedRule"
    }
}

Nested Schema : ListedRule

Type: object

A rule configuration as displayed when getting as a list.

Show Source

• ecr:createDate: string
• ecr:lastModified: string
• ecr:lastModifiedBy: string
• ecr:type: string
  Default Value: content-item
• priority: integer(int32)
  Specifies the rule priority. In case of rule clash, 'priority' would be used internally to pick the rule with high priority. Lower the number means higher the priority.
• workflowState: string
  Specifies if the rule is active or not. Accepted values are ACTIVE / INACTIVE with default being 'ACTIVE'.

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"content-item"
        },
        "workflowState":{
            "type":"string",
            "description":"Specifies if the rule is active or not. Accepted values are ACTIVE / INACTIVE with default being 'ACTIVE'."
        },
        "priority":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the rule priority. In case of rule clash, 'priority' would be used internally to pick the rule with high priority. Lower the number means higher the priority."
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"A rule configuration as displayed when getting as a list."
}

Back to Top