/api/v2/bpm/conditionsRules

Метод создает новое правило

application/json

Request Body

• ruleName string required

  Possible values: non-empty and <= 255 characters

  Краткое описание правила

• methodId int64

  ID вызываемого метода сервиса внутренней экосистемы (LMS)

• resultApiField string

  Possible values: non-empty and <= 255 characters

  Путь до поля в ответе, который вернулся с API сервиса внутренней экосистемы. Значение из этого поля, либо фрагмент ответа используются для сравнения с эталонным значением

• operator string

  Possible values: non-empty and <= 8 characters

  Оператор сравнения с ответом (<,>,=,!=,in,null,not null)

• isRequired boolean

  Флаг обязательности выполнения правила

• fieldName string

  Possible values: non-empty and <= 255 characters

  Шаблон ID переменной связанной с нодой типа 'поле', либо имя этой переменной. Значение для этой переменной можно получить с экрана пользователя и также сверить его с эталонным значением

• answer string

  Possible values: non-empty and <= 255 characters

  Эталонное значение, с которым идет сравнение

Responses

• 201
• 400
• 401

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "Condition rule is successfully created",
  "response": {
    "id": 699,
    "ruleName": "Клиент присутствует в БД (test_3)",
    "methodId": 1,
    "resultApiField": "body.status",
    "fieldName": "{{field.7707}}",
    "operator": "!=",
    "answerId": null,
    "answer": "1",
    "isRequired": true
  },
  "preparingsTime": 0.071
}

Bad Request

application/json

• Schema
• Example (from schema)
• example-0
• example-1
• example-2

---

Schema

• object

{}

400

{
  "status": 0,
  "message": "Required ruleName",
  "response": {},
  "preparingsTime": 0.045
}

400_2

{
  "status": 0,
  "message": {
    "ruleName": [
      "This field may not be blank."
    ],
    "methodId": [
      "Method width id='None' was not found"
    ],
    "resultApiField": [
      "This field may not be blank."
    ],
    "fieldName": [
      "This field may not be blank."
    ],
    "operator": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.04
}

400_3

{
  "status": 0,
  "message": {
    "ruleName": [
      "This field may not be null."
    ],
    "methodId": [
      "Method width id='None' was not found"
    ],
    "operator": [
      "Valid operator values are ('>', '<', '=', '>=', '<=', '!=')"
    ]
  },
  "response": {},
  "preparingsTime": 0.041
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 0,
  "message": "Authentication credentials were not provided.",
  "response": {
    "detail": "Authentication credentials were not provided."
  },
  "preparingsTime": 0.002
}

Loading...