Sha256: 4431482a86447b4d3382a0deee1218a90cf78c7113c77feb20b5d585bad0ba16

Contents?: true

Size: 1.88 KB

Versions: 15

Compression:

Stored size: 1.88 KB

Contents

# PulpAnsibleClient::PulpAnsibleTagsApi

All URIs are relative to *http://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.
  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
  #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] 
 **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

[**PaginatedTagResponseList**](PaginatedTagResponseList.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

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

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
pulp_ansible_client-0.22.0 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.7 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.21.6 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.5 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.4 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.21.3 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.21.2 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.3 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.21.1 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.21.0 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.2 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.1 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.18.2 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.20.0 docs/PulpAnsibleTagsApi.md
pulp_ansible_client-0.18.1 docs/PulpAnsibleTagsApi.md