This documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.Chapter 50. Policy Category Service
50.1. Policy Category Service Copy linkLink copied to clipboard!
50.1.1. DeletePolicyCategory Copy linkLink copied to clipboard!
DELETE /v1/policycategories/{id}
DeletePolicyCategory removes the given policy category.
50.1.1.1. Description Copy linkLink copied to clipboard!
50.1.1.2. Parameters Copy linkLink copied to clipboard!
50.1.1.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.1.1.3. Return Type Copy linkLink copied to clipboard!
Object
50.1.1.4. Content Type Copy linkLink copied to clipboard!
- application/json
50.1.1.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
50.1.1.6. Samples Copy linkLink copied to clipboard!
50.1.2. GetPolicyCategories Copy linkLink copied to clipboard!
GET /v1/policycategories
GetPolicyCategories returns the list of policy categories
50.1.2.1. Description Copy linkLink copied to clipboard!
50.1.2.2. Parameters Copy linkLink copied to clipboard!
50.1.2.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
50.1.2.3. Return Type Copy linkLink copied to clipboard!
50.1.2.4. Content Type Copy linkLink copied to clipboard!
- application/json
50.1.2.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.2.6. Samples Copy linkLink copied to clipboard!
50.1.3. GetPolicyCategory Copy linkLink copied to clipboard!
GET /v1/policycategories/{id}
GetPolicyCategory returns the requested policy category by ID.
50.1.3.1. Description Copy linkLink copied to clipboard!
50.1.3.2. Parameters Copy linkLink copied to clipboard!
50.1.3.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.1.3.3. Return Type Copy linkLink copied to clipboard!
50.1.3.4. Content Type Copy linkLink copied to clipboard!
- application/json
50.1.3.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.3.6. Samples Copy linkLink copied to clipboard!
50.1.4. PostPolicyCategory Copy linkLink copied to clipboard!
POST /v1/policycategories
PostPolicyCategory creates a new policy category
50.1.4.1. Description Copy linkLink copied to clipboard!
50.1.4.2. Parameters Copy linkLink copied to clipboard!
50.1.4.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| policyCategory | X |
50.1.4.3. Return Type Copy linkLink copied to clipboard!
50.1.4.4. Content Type Copy linkLink copied to clipboard!
- application/json
50.1.4.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.4.6. Samples Copy linkLink copied to clipboard!
50.1.5. RenamePolicyCategory Copy linkLink copied to clipboard!
PUT /v1/policycategories
RenamePolicyCategory renames the given policy category.
50.1.5.1. Description Copy linkLink copied to clipboard!
50.1.5.2. Parameters Copy linkLink copied to clipboard!
50.1.5.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
50.1.5.3. Return Type Copy linkLink copied to clipboard!
50.1.5.4. Content Type Copy linkLink copied to clipboard!
- application/json
50.1.5.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |