/api/v2/bpm/properties/types

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

application/json

Request Body

• name string required

  Possible values: non-empty and <= 255 characters

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

• description string

  Possible values: non-empty and <= 255 characters

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

• settings object

  Дополнительные свойства типа (регулярка, возвращаемый тип, требуется ли мультилэнг)

Responses

• 201
• 400
• 401

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "PropertyType is successfully created",
  "response": {
    "id": 9,
    "name": "RGB",
    "description": "red, green, blue",
    "settings": {
      "red": [
        0,
        255
      ],
      "green": [
        0,
        255
      ],
      "blue": [
        0,
        255
      ]
    }
  },
  "preparingsTime": 0.09
}

Bad Request

application/json

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

---

Schema

• object

{}

400

{
  "status": 0,
  "message": "Required name",
  "response": {},
  "preparingsTime": 0.031
}

400_2

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

400_3

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

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

Loading...