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

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

Path Parameters

id integer required
ID, под которым хранится API внешнего сервиса
Example: 83

application/json

Request Body

apiName string required
Possible values: non-empty and <= 255 characters
Наименование точки доступа к стороннему API
apiUrl string
Possible values: non-empty and <= 255 characters
URL точки доступа к внешнему API
token string
Possible values: non-empty and <= 4096 characters
Токен для авторизации во внешнем апи / access token
authorization string
Possible values: non-empty and <= 255 characters
Тип авторизации (Bearer, ApiKey, Basic)
signKey string
Possible values: non-empty and <= 255 characters
???Ключ для подписи например, jwt
encryptKey string
Possible values: non-empty and <= 255 characters
???Ключ для шифрования строки
expKey int64
Время действия jwt токена
headers object
Заголовки, отправляемые при вызове методов стороннего API
parentId int64
ID родительской точки доступа к стороннему API
enviroment string
Среда на которой используется сторонний API

Responses

application/json

Schema
Example (from schema)
Example

Schema

object

{}

{
  "status": 1,
  "message": "InstanceListApi is successfully updated",
  "response": {
    "id": 83,
    "apiName": "Test_3333",
    "apiUrl": "https://testdef.vivamoney.in.regerger",
    "token": "e4zDYnAd3iMk7wTO9K1?jiUA?5SjTIY3Pu4MR",
    "authorization": "API key",
    "signKey": "Vasilii Pupkin",
    "encryptKey": "base64",
    "expKey": 9999,
    "headers": {
      "Connection": "keep-alive"
    },
    "parentId": 70,
    "environment": "development"
  },
  "preparingsTime": 0.064
}

Bad Request

application/json

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

Schema

object

{}

400(404)

{
  "status": 0,
  "message": "Not found",
  "response": {},
  "preparingsTime": 0.083
}

400

{
  "status": 0,
  "message": {
    "apiName": [
      "This field may not be blank."
    ],
    "apiUrl": [
      "This field may not be blank."
    ],
    "signKey": [
      "This field may not be blank."
    ],
    "encryptKey": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.033
}

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

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

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