/api/v2/bpm/editor/nodes/{node_id}/nodesParam

Метод обновляет дополнительную информацию о ноде по ID.

Возможно будет упразднен в будущем, и его функционал заместится методом: PATCH editor/nodes/:node_id

Path Parameters

• node_id integer required

  ID ноды, любой из основных структурных единиц проекта в BPMS

  Example: 1173036

application/json

Request Body

• name string

  Possible values: non-empty and <= 255 characters

  Уникальное имя ноды. В рамках одного типа ноды имена всегда уникальны, при попытке создания элемента с одинаковым именем произойдет перезапись предыдущего элемента

• title string

  Possible values: non-empty and <= 255 characters

  Не уникальное имя ноды, использующееся для отображения в интерфейсах

• description string

  Possible values: non-empty

  Описание ноды

• version string

  Possible values: non-empty and <= 25 characters

  ???

• isAsync boolean

  Флаг асинхронного запуска ноды-функции

• function string

  Possible values: non-empty

  Код функции в ноде

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "Nodes param is successfully updated",
  "response": {
    "id": 3137,
    "name": "preset_for_qa_test_30",
    "title": "preset_for_qa_test_30",
    "description": "random_string_30",
    "version": "last",
    "isAsync": false,
    "function": "a = 'Hello world!'"
  },
  "preparingsTime": 0.36
}

Bad Request

application/json

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

---

Schema

• object

{}

400(404)

{
  "status": 0,
  "message": "Node with id='9999999' was not found",
  "response": {},
  "preparingsTime": 0.081
}

400

{
  "status": 0,
  "message": {
    "name": [
      "This field may not be null."
    ],
    "version": [
      "This field may not be null."
    ]
  },
  "response": {},
  "preparingsTime": 0.222
}

400_2

{
  "status": 0,
  "message": {
    "name": [
      "This field may not be blank."
    ],
    "title": [
      "This field may not be blank."
    ],
    "description": [
      "This field may not be blank."
    ],
    "version": [
      "This field may not be blank."
    ],
    "function": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.615
}

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

Loading...