# PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi

All URIs are relative to *http://localhost:24817*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](PulpAnsibleGalaxyApiV3CollectionsApi.md#create) | **POST** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/ | 
[**read**](PulpAnsibleGalaxyApiV3CollectionsApi.md#read) | **GET** {collection_import_href} | Inspect a collection import



## create

> create(path)



ViewSet for CollectionVersions.

### Example

```ruby
# load the gem
require 'pulp_ansible_client'
# setup authorization
PulpAnsibleClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi.new
path = 'path_example' # String | 

begin
  api_instance.create(path)
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling PulpAnsibleGalaxyApiV3CollectionsApi->create: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **path** | **String**|  | 

### Return type

nil (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


## read

> CollectionImportDetail read(collection_import_href, opts)

Inspect a collection import

ViewSet for CollectionImports.

### Example

```ruby
# load the gem
require 'pulp_ansible_client'
# setup authorization
PulpAnsibleClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi.new
collection_import_href = 'collection_import_href_example' # String | URI of Collection Import. e.g.: /pulp_ansible/galaxy/1/api/v3/imports/collections/1/
opts = {
  fields: 'fields_example' # String | A list of fields to include in the response.
}

begin
  #Inspect a collection import
  result = api_instance.read(collection_import_href, opts)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling PulpAnsibleGalaxyApiV3CollectionsApi->read: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_import_href** | **String**| URI of Collection Import. e.g.: /pulp_ansible/galaxy/1/api/v3/imports/collections/1/ | 
 **fields** | **String**| A list of fields to include in the response. | [optional] 

### Return type

[**CollectionImportDetail**](CollectionImportDetail.md)

### Authorization

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

### HTTP request headers

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