/api/v2/bpm/roles

Метод создает новую роль для пользователей BPMS с определенным набором разрешений

Header Parameters

• Authorization string
  Example: {{token}}

application/json

Request Body

• name string required

  Possible values: non-empty and <= 255 characters

  Наименование роли пользователя BPMS

• description string

  Possible values: non-empty and <= 255 characters

  Краткое описание роли пользователя BPMS

• permissions int64[] required

  Массив разрешениями (допусками к использованию различных эндпоинтов)

Responses

• 201
• 400
• 401

---

Created

application/json

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

---

Schema

• object

{}

201(400)

{
  "status": 1,
  "message": "Roles is successfully created",
  "response": {
    "id": 5,
    "name": "",
    "description": null
  },
  "preparingsTime": 0.056
}

201

{
  "status": 1,
  "message": "Roles is successfully created",
  "response": {
    "id": 4,
    "name": "QA Engineer",
    "description": "Test environment only"
  },
  "preparingsTime": 0.067
}

Bad Request

application/json

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

---

Schema

• object

{}

400

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

400_2

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

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

Loading...