/api/v2/bpm/references

Метод создает новое значение с атрибутами в универсальном справочнике

application/json

Request Body

• propertyId int64 required

  ID свойства, которое хранит свои значения в универсальном справочнике

• name string

  Possible values: non-empty and <= 255 characters

  Наименование элемента справочника (значение элемента справочника)

• description string

  Possible values: non-empty and <= 255 characters

  Краткое описание элемента справочника

• value object

  Объект содержащий дополнительные значения в элементе справочника

• order int64

  Порядок отображения элементов в справочнике

Responses

• 201
• 400
• 401

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "ReferencesUniversal is successfully created",
  "response": {
    "id": 193,
    "propertyId": 378,
    "name": "RGB scheme",
    "description": "Default black color",
    "value": {
      "red": 0,
      "green": 0,
      "blue": 0
    },
    "order": 1
  },
  "preparingsTime": 0.063
}

Bad Request

application/json

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

---

Schema

• object

{}

400

{
  "status": 0,
  "message": "Required propertyId",
  "response": {},
  "preparingsTime": 0.036
}

400_2

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

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

Loading...