Update

Update

Query Parameters

project_id int64 required

The project id

project_type ProjectType required

Possible values: [SMART_CONTENT, CONTENT_GENERATION]

The project type

application/json

Request Body array required

• Array [
description string

Description for the rule

fixes object[]
The list of fixes to apply when the rule validation fails.
Array [
type ValidationTypeEnum
Possible values: [FIND_AND_REPLACE, OPEN_AI, APPEND]
what string
with string
]
is_enabled boolean
level LevelEnum required

Possible values: [RECOMMENDED, REQUIRED]

The rule level.

name string required

The rule name.

project_id int64

The project id, if applicable.

project_type ProjectType

Possible values: [SMART_CONTENT, CONTENT_GENERATION]

The project type, if applicable.

scope Scope required

Possible values: [USER, PROJECT]

The rule scope.

type string required

The rule type, one of field, word or code. By default field.

what_operand_lhs WhatOperandLhs required

Possible values: [EVERYWHERE, FIRST_SENTENCE, LAST_SENTENCE]

The left hand side operand for what condition.

what_operand_rhs string required

The right hand side operand for what condition.

what_operator WhatOperator required

Possible values: [CONTAINS, DOESNT_CONTAIN, ENDS_WITH, REGEX, REGEX_DOESNT_MATCH]

The operator for what condition.

when_operand_lhs string required

The left hand side operand for when condition.

when_operand_rhs string required

The right hand side operand for when condition.

when_operator WhenOperator required

Possible values: [ALWAYS, EQUALS, NOT_EQUALS]

The operator for when condition.

• ]

Responses

• 200
• 400
• 401

---

Found.

application/json

Schema

Example (from schema)

---

Schema

• Array [
created_at date-time

The create date-time.

description string

Description for the rule

fixes object[]
The list of fixes to apply when the rule validation fails.
Array [
type ValidationTypeEnum
Possible values: [FIND_AND_REPLACE, OPEN_AI, APPEND]
what string
with string
]
id int64
is_enabled boolean
level LevelEnum required

Possible values: [RECOMMENDED, REQUIRED]

The rule level.

modified_at date-time

The last modified date-time.

name string required

The rule name.

project_id int64
project_type ProjectType

Possible values: [SMART_CONTENT, CONTENT_GENERATION]

The project type, if applicable.

scope Scope required

Possible values: [USER, PROJECT]

The rule scope.

type string required

The rule type, one of field, word or code. By default field.

what_operand_lhs WhatOperandLhs required

Possible values: [EVERYWHERE, FIRST_SENTENCE, LAST_SENTENCE]

The left hand side operand for what condition.

what_operand_rhs string required

The right hand side operand for what condition.

what_operator WhatOperator required

Possible values: [CONTAINS, DOESNT_CONTAIN, ENDS_WITH, REGEX, REGEX_DOESNT_MATCH]

The operator for what condition.

when_operand_lhs string required

The left hand side operand for when condition.

when_operand_rhs string required

The right hand side operand for when condition.

when_operator WhenOperator required

Possible values: [ALWAYS, EQUALS, NOT_EQUALS]

The operator for when condition.

• ]

[
  {
    "created_at": "2024-12-19T10:40:03.874Z",
    "description": "string",
    "fixes": [
      {
        "type": "FIND_AND_REPLACE",
        "what": "string",
        "with": "string"
      }
    ],
    "id": 0,
    "is_enabled": true,
    "level": "RECOMMENDED",
    "modified_at": "2024-12-19T10:40:03.874Z",
    "name": "string",
    "project_id": 0,
    "project_type": "SMART_CONTENT",
    "scope": "USER",
    "type": "string",
    "what_operand_lhs": "EVERYWHERE",
    "what_operand_rhs": "string",
    "what_operator": "CONTAINS",
    "when_operand_lhs": "string",
    "when_operand_rhs": "string",
    "when_operator": "ALWAYS"
  }
]

Bad request

Authentication Failure

Loading...