/api/v2/bpm/endpoints

Метод добавляет прокси эндпоинт в список всех активных инстансов BPMS (совместно работающих BPM, LMS, CRM и прочих сервисов)

application/json

Request Body

• instanceId int64 required

  ID инстанса

• endpointUrl string

  Possible values: non-empty and <= 255 characters

  URL эндпоинта нашего API (только BPMS) для вызова внешними сервисами

• function string

  Possible values: non-empty and <= 255 characters

  Функция или метод класса (class.method) для вызова в приложении

• logId int64

  ID из универсального справочника для отправки лога (события)

• apiMethodId int64

  ID метода API внешней системы, который будет вызывать наш (BPMS) метод (проксируем запрос)

• nodeFuncId int64

  ???

• nodeProcessId int64

  ???

• requestJson object

  Объект содержащий входные параметры ожидаемые нашим сервисом (BPMS) для метода

  body object

  Информация об ожидаемых данных в теле и местах их сохранения при запросе от внешнего API

  status string

  Игнорируется тут

  cookies object

  Ожидаемые куки запроса от внешнего API и места их сохранения

  id string

  Expires string

  headers object

  Ожидаемые заголовки запроса от внешнего API и места их сохранения

  sessionId string
• responseJson object

  Объект содержащий выходные параметры от нашего метода API (BPMS)

  body object

  Тело, которым отвечает BPMS после выполнения логики эндпойнта

  status string

  Игнорируется тут

  cookies object

  Куки, которые использует BPMS при формировании ответа

  id string

  Expires string

  headers object

  Заголовки, которые использует BPMS при формировании ответа

  sessionId string

Responses

• 201
• 400
• 401

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "InstanceEndpoint is successfully created",
  "response": {
    "id": 108,
    "instanceId": 3,
    "endpointUrl": "lms/checkVKYSStatus/{{field.5304}}",
    "function": "Hello world",
    "logId": 10,
    "apiMethodId": null,
    "nodeFuncId": 1172304,
    "requestJson": {
      "actionName": "new_action_for_test",
      "actionType": "exit",
      "parameters": [
        "{{prop.1000_2000}}",
        "{{prop.1111_2222}}"
      ]
    },
    "responseJson": {
      "status": 1,
      "message": "Actions is successfully created",
      "response": {
        "id": 108,
        "actionName": "new_action_for_test",
        "actionAlias": "action.exit({{prop.1000_2000}}, {{prop.1111_2222}})",
        "actionType": "exit",
        "parameters": [
          "{{prop.1000_2000}}",
          " {{prop.1111_2222}}"
        ]
      },
      "preparingsTime": 0.081
    }
  },
  "preparingsTime": 0.165
}

Bad Request

application/json

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

---

Schema

• object

{}

400

{
  "status": 0,
  "message": "Required instanceId",
  "response": {},
  "preparingsTime": 0.044
}

400_2

{
  "status": 0,
  "message": {
    "instanceId": [
      "This field may not be null."
    ],
    "endpointUrl": [
      "This field may not be blank."
    ],
    "function": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.035
}

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.003
}

Loading...