Role Categories: Edit
Description
Modify the attributes of a given Role Category.
HTTP Request
PATCH /api/v1beta0/account/accountId/role-categories/roleCategoryId/
Parameters
| Name | Required | Description | Location |
|---|---|---|---|
| accountId integer |
Yes | The ID of the Account scoping this request. |
path |
| roleCategoryId integer |
Yes | The ID of a RoleCategory object. |
path |
Request body
The JSON representation of a RoleCategory object.
The body must be a valid RoleCategory object. Example value:
{
"name": "string"
}
Successful Response (Status 200)
The JSON representation of a RoleCategory object.
The API replies with a RoleCategoryDetailsResponse object. Example response body:
{
"data": {
"id": 1,
"name": "string",
"scope": "scalr"
},
"errors": [
{
"code": "string",
"message": "string"
}
],
"meta": {
"sample": "string"
},
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
Other Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | A client-side error was made. |
An ApiErrorResponse object |
| 401 | The request was not authenticated. |
An ApiErrorResponse object |
| 403 | Insufficient permissions. |
An ApiErrorResponse object |
| 404 | Resource not found. |
An ApiErrorResponse object |
| 409 | Conflict with current state. |
An ApiErrorResponse object |
| 422 | This request was well-formed but was rejected due to semantic errors. |
An ApiErrorResponse object |
| 500 | A server-side error occurred. |
An ApiErrorResponse object |
| 501 | This feature is not implemented in Scalr. |
An ApiErrorResponse object |
| 503 | The service is currently unavailable. |
An ApiErrorResponse object |