List Rules
List Rules
Path Parameters
- contentGenerationId int64 required
The Content Generation id.
Query Parameters
- cursor string required
The cursor
- limit integer required
Default value:
10
The maximum number of results
- 200
- 401
Found.
- application/json
- Schema
- Example (from schema)
Schema
- first string nullable required
The link to the first page.
items object[] required
An array of objects.
Array [content_generation_id int64 requiredThe parent content generation id.
description string requiredDescription for the rule
fixes object[]
The list of fixes to apply when the rule validation fails.
Array [type ValidationTypeEnum requiredPossible values: [
FIND_AND_REPLACE
,OPEN_AI
,APPEND
]what string requiredwith string required]id int64 requiredlevel LevelEnum requiredPossible values: [
RECOMMENDED
,REQUIRED
]The rule level.
name string requiredThe rule name.
type string requiredThe rule type, one of
field
,word
orcode
. By defaultfield
.what_operand_lhs WhatOperandLhs requiredPossible values: [
EVERYWHERE
,FIRST_SENTENCE
,LAST_SENTENCE
]The left hand side operand for what condition.
what_operand_rhs string requiredThe right hand side operand for what condition.
what_operator WhatOperator requiredPossible values: [
CONTAINS
,DOESNT_CONTAIN
,ENDS_WITH
]The operator for what condition.
when_operand_lhs string requiredThe left hand side operand for when condition.
when_operand_rhs string requiredThe right hand side operand for when condition.
when_operator WhenOperator requiredPossible values: [
ALWAYS
,EQUALS
,NOT_EQUALS
]The operator for when condition.
]- last string nullable required
The link to the last page.
- next string nullable required
The link to the next page or
null
if there's no page. - prev string nullable required
The link to the previous page or
null
if there's no page. - self string nullable required
The link to the current page.
{
"first": "string",
"items": [
{
"content_generation_id": 0,
"description": "string",
"fixes": [
{
"type": "FIND_AND_REPLACE",
"what": "string",
"with": "string"
}
],
"id": 0,
"level": "RECOMMENDED",
"name": "string",
"type": "string",
"what_operand_lhs": "EVERYWHERE",
"what_operand_rhs": "string",
"what_operator": "CONTAINS",
"when_operand_lhs": "string",
"when_operand_rhs": "string",
"when_operator": "ALWAYS"
}
],
"last": "string",
"next": "string",
"prev": "string",
"self": "string"
}
Authentication Failure