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.
Response
Supported Media Types
- application/json
- application/zip
200 Response
Rule configuration.
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'.
Nested Schema : siteIds
Type:
array
Specifies the list of site IDs that this rule belongs to
Show Source
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.
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.
Nested Schema : dvalIDs
Type:
array
List of dimension ID's on which trigger is configured.
Show Source
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