Jump to

• Request
• Response
• Examples

View rule definition

get

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

Returns rule configuration. If zip extension is specified (add ".zip" at the end of the path), rule configuration is exported as a zip file.

Request

Supported Media Types

• application/json

Path Parameters

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

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

Rule configuration.

Body ()

Root Schema : Rule

Type: object

Represents a rule configuration.

Show Source

• contentItem(optional): object ContentItemObject
• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: content-item
• priority(optional): 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.
• siteIds(optional): array siteIds
  Specifies the list of site IDs that this rule belongs to
• triggers(optional): array triggers
  Specifies the trigger conditions when this rule should be triggered. Business user can configure a trigger based on either search term or navigation state.
• workflowState(optional): 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."
        },
        "contentItem":{
            "description":"Defines a contentItem object",
            "$ref":"#/definitions/ContentItemObject"
        },
        "triggers":{
            "type":"array",
            "description":"Specifies the trigger conditions when this rule should be triggered. Business user can configure a trigger based on either search term or navigation state.",
            "items":{
                "$ref":"#/definitions/RuleTrigger"
            }
        },
        "siteIds":{
            "type":"array",
            "description":"Specifies the list of site IDs that this rule belongs to",
            "items":{
                "type":"string"
            }
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents a rule configuration."
}

Nested Schema : ContentItemObject

Type: object

Show Source

• @name(optional): string
• @type(optional): string

{
    "type":"object",
    "properties":{
        "@name":{
            "type":"string"
        },
        "@type":{
            "type":"string"
        }
    }
}

Nested Schema : siteIds

Type: array

Specifies the list of site IDs that this rule belongs to

Show Source

• Array of: string

{
    "type":"array",
    "description":"Specifies the list of site IDs that this rule belongs to",
    "items":{
        "type":"string"
    }
}

Nested Schema : triggers

Type: array

Specifies the trigger conditions when this rule should be triggered. Business user can configure a trigger based on either search term or navigation state.

Show Source

• Array of: object RuleTrigger
  Allows you to configure a trigger on a search term or navigation state or both.

{
    "type":"array",
    "description":"Specifies the trigger conditions when this rule should be triggered. Business user can configure a trigger based on either search term or navigation state.",
    "items":{
        "$ref":"#/definitions/RuleTrigger"
    }
}

Nested Schema : RuleTrigger

Type: object

Allows you to configure a trigger on a search term or navigation state or both.

Show Source

• dvalIDs(optional): array dvalIDs
  List of dimension ID's on which trigger is configured.
• matchmode(optional): string
  Specifies the match mode how a search term would be evaluated for a match. Allowed values are MATCHPHRASE, MATCHEXACT and MATCHALL
• searchTerms(optional): string
  Search term on which trigger is configured.

{
    "type":"object",
    "properties":{
        "dvalIDs":{
            "type":"array",
            "description":"List of dimension ID's on which trigger is configured.",
            "items":{
                "type":"string"
            }
        },
        "searchTerms":{
            "type":"string",
            "description":"Search term on which trigger is configured."
        },
        "matchmode":{
            "type":"string",
            "description":"Specifies the match mode how a search term would be evaluated for a match. Allowed values are MATCHPHRASE, MATCHEXACT and MATCHALL"
        }
    },
    "description":"Allows you to configure a trigger on a search term or navigation state or both."
}

Nested Schema : dvalIDs

Type: array

List of dimension ID's on which trigger is configured.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of dimension ID's on which trigger is configured.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to view the rule configuration named aboutus:

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsadmin/v1/cloud/content/additionalContent/aboutus

Back to Top