Sha256: 8b23643962416def74cdbdbaf5af5401a474d1c1a7c2245b06d2d8ac836d33e9

Contents?: true

Size: 1.78 KB

Versions: 14

Compression:

Stored size: 1.78 KB

Contents

# PulpAnsibleClient::ApiRolesApi

All URIs are relative to *https://pulp*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](ApiRolesApi.md#get) | **GET** {ansible_role_href}api/v1/roles/ | 



## get

> PaginatedGalaxyRoleResponseList get(ansible_role_href, opts)



APIView for Roles.

### Example

```ruby
# load the gem
require 'pulp_ansible_client'

api_instance = PulpAnsibleClient::ApiRolesApi.new
ansible_role_href = 'ansible_role_href_example' # String | 
opts = {
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}

begin
  result = api_instance.get(ansible_role_href, opts)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling ApiRolesApi->get: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ansible_role_href** | **String**|  | 
 **limit** | **Integer**| Number of results to return per page. | [optional] 
 **offset** | **Integer**| The initial index from which to return the results. | [optional] 
 **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
 **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 

### Return type

[**PaginatedGalaxyRoleResponseList**](PaginatedGalaxyRoleResponseList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
pulp_ansible_client-0.16.2 docs/ApiRolesApi.md
pulp_ansible_client-0.15.4 docs/ApiRolesApi.md
pulp_ansible_client-0.17.5 docs/ApiRolesApi.md
pulp_ansible_client-0.17.4 docs/ApiRolesApi.md
pulp_ansible_client-0.19.0 docs/ApiRolesApi.md
pulp_ansible_client-0.17.3 docs/ApiRolesApi.md
pulp_ansible_client-0.17.2 docs/ApiRolesApi.md
pulp_ansible_client-0.18.0 docs/ApiRolesApi.md
pulp_ansible_client-0.17.1 docs/ApiRolesApi.md
pulp_ansible_client-0.17.0 docs/ApiRolesApi.md
pulp_ansible_client-0.15.3 docs/ApiRolesApi.md
pulp_ansible_client-0.16.1 docs/ApiRolesApi.md
pulp_ansible_client-0.15.2 docs/ApiRolesApi.md
pulp_ansible_client-0.15.1 docs/ApiRolesApi.md