/api/v2/bpm/properties

Метод создает новое свойство

application/json

Request Body

• name string required

  Possible values: non-empty and <= 255 characters

  Наименование свойства

• parentId int64

  ID родительского свойства

• typeId int64

  ID типа свойства (для сборки url, например)

• isGlobal boolean required

  Флаг указывающий, что свойство являтся глобальным для всего проекта

• isGroup boolean

  ???Флаг указывающий, что свойство является группой

• tableReference string

  Possible values: non-empty and <= 255 characters

  ???Наименование таблицы на которую ссылается свойство (для справочника)

• description string

  Possible values: non-empty and <= 255 characters

  Описание свойства

• refValues int64

  ???Количество символов с конца строки, которые останутся видны в логах

• order int64

  Порядковый номер отображения свойства

Responses

• 201
• 400
• 401

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "Property is successfully created",
  "response": {
    "id": 380,
    "name": "third_prop_over_month",
    "parentId": 378,
    "typeId": 6,
    "type": "object",
    "isGlobal": true,
    "isGroup": false,
    "tableReference": "ref_universal",
    "description": "matreshka_test_2",
    "defaultValue": null,
    "refValues": [],
    "order": 2
  },
  "preparingsTime": 0.096
}

Bad Request

application/json

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

---

Schema

• object

{}

400

{
  "status": 0,
  "message": {
    "name": [
      "This field is required."
    ],
    "isGlobal": [
      "This field is required."
    ]
  },
  "response": {},
  "preparingsTime": 0.035
}

400_2

{
  "status": 0,
  "message": {
    "name": [
      "This field may not be blank."
    ],
    "typeId": [
      "This field may not be null."
    ],
    "tableReference": [
      "This field may not be blank."
    ],
    "description": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.048
}

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