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
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

Rule

Type: string

Required: true

Specifies the name of rule.

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

contentCollectionFolder

Type: string

Required: true

Specifies the name of content collection folder.

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json
• application/zip

200 Response

Rule configuration.

Body

Represents a rule configuration.

Root Schema : Rule

Type: object

Represents a rule configuration.

Properties

contentItem

Type: object ContentItemObject

Additional Properties Allowed:

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: content-item

priority

Type: 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.

triggers

Type: array triggers

Additional Properties Allowed:

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

Type: string

Specifies if the rule is active or not. Accepted values are ACTIVE / INACTIVE with default being 'ACTIVE'.

Nested Schema : ContentItemObject

Type: object

Properties

@name

Type: string

@type

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.

Items

• Type: object RuleTrigger
  Additional Properties Allowed:
  Allows you to configure a trigger on a search term or navigation state or both.

Nested Schema : RuleTrigger

Type: object

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

Properties

dvalIDs

Type: array dvalIDs

Additional Properties Allowed:

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

matchmode

Type: string

Specifies the match mode how a search term would be evaluated for a match. Allowed values are MATCHPHRASE, MATCHEXACT and MATCHALL

searchTerms

Type: string

Search term on which trigger is configured.

Nested Schema : dvalIDs

Type: array

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

Items

• Type: string

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