Sha256: 980708ed09a3bc37863eb2081d8f013e93bdea1d4b21b9f44d941dfc9a89b3d7
Contents?: true
Size: 1.99 KB
Versions: 16
Compression:
Stored size: 1.99 KB
Contents
# PulpAnsibleClient::PulpAnsibleTagsApi
All URIs are relative to *https://pulp*
Method | HTTP request | Description
------------- | ------------- | -------------
[**list**](PulpAnsibleTagsApi.md#list) | **GET** /pulp/api/v3/pulp_ansible/tags/ | List tags
## list
> PaginatedTagResponseList list(opts)
List tags
ViewSet for Tag models.
### Example
```ruby
# load the gem
require 'pulp_ansible_client'
# setup authorization
PulpAnsibleClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = PulpAnsibleClient::PulpAnsibleTagsApi.new
opts = {
limit: 56, # Integer | Number of results to return per page.
offset: 56, # Integer | The initial index from which to return the results.
ordering: 'ordering_example', # String | Which field to use when ordering the results.
fields: 'fields_example', # String | A list of fields to include in the response.
exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}
begin
#List tags
result = api_instance.list(opts)
p result
rescue PulpAnsibleClient::ApiError => e
puts "Exception when calling PulpAnsibleTagsApi->list: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of results to return per page. | [optional]
**offset** | **Integer**| The initial index from which to return the results. | [optional]
**ordering** | **String**| Which field to use when ordering the results. | [optional]
**fields** | **String**| A list of fields to include in the response. | [optional]
**exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatedTagResponseList**](PaginatedTagResponseList.md)
### Authorization
[basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
Version data entries
16 entries across 16 versions & 1 rubygems