/api/v2/bpm/extApi/methods/{id}

Метод по ID обновляет информацию о прокси эндпоинте внешней системы интегрированной с BPMS

Path Parameters

id integer required
ID прокси метода внешнего сервиса
Example: 1007

application/json

Request Body

apiId int64 required
ID точки доступа стороннего API
typeId int64
ID типа метода (get/post/put/patch)
methodUrl string
Possible values: non-empty and <= 255 characters
URL метода стороннего API
methodName string
Possible values: non-empty and <= 255 characters
Наименование метода
requestJson object
Входные параметры ожидаемые сторонним API для метода
body object
Ожидаемое сторонним API тело запроса
status string
Параметр игнорируется
cookies object
Ожидаемые куки для запроса к стороннему API
id string
Expires string
headers object
Ожидаемые заголовки для запроса к стороннему API
sessionId string
responseJson object
Выходные параметры ответа от метода стороннего API
body object
Тело ответа на запрос
status string
Параметр игнорируется
cookies object
Куки, которые возвращаются в ответе
id string
Expires string
headers object
Заголовки, которые возвращаются в ответе
sessionId string
responseTypeId int64
ID возвращаемого типа данных (например JSON)
timeoutConnect int64
Максимальное время, которое BPMS готов ждать при попытке установить соединение со сторонним API
timeoutReceive int64
Максимальное время, в течение которого BPMS готов ждать ответа от стороннего API после успешного установления соединения

Responses

application/json

Schema
Example (from schema)
Example

Schema

object

{}

{
  "status": 1,
  "message": "InstanceApiMethod is successfully updated",
  "response": {
    "id": 1007,
    "apiId": 84,
    "typeId": 1,
    "methodUrl": "https://www.notion.so/started_page",
    "methodName": "Стартовая страница ноушен",
    "requestJson": {
      "token": "WC9nx!XeAV?XGQtLXcfLGXPy0VFcRXO2c9rKCsYsOU6BRUcagic"
    },
    "responseJson": {
      "response": {
        "status": 1,
        "message": "Token is inactive",
        "response": {}
      }
    },
    "responseTypeId": 1,
    "timeoutConnect": 15,
    "timeoutReceive": 15
  },
  "preparingsTime": 0.076
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

object

{}

{
  "status": 0,
  "message": {
    "apiId": [
      "This field may not be null."
    ],
    "typeId": [
      "This field may not be null."
    ],
    "methodUrl": [
      "This field may not be blank."
    ],
    "methodName": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.08
}

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
}

/api/v2/bpm/extApi/methods/{id}​

/api/v2/bpm/extApi/methods/{id}