Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.99 KB

RegistryApi.md

File metadata and controls

76 lines (56 loc) · 2.99 KB
Raw

RegistryApi

All URIs are relative to https://localhost/api/v5

Method HTTP request Description
getRegistry GET /registry/{class} Get a catalog type

getRegistry

List<CatalogType> getRegistry(propertyClass, details, accept, pretty)

Get a catalog type

Lists all the catalog values of a specified CatalogType. Required permissions: - registry.one

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.RegistryApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");

// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");

RegistryApi apiInstance = new RegistryApi();
String propertyClass = "propertyClass_example"; // String | The fully qualified classname of the catalog type
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
    List<CatalogType> result = apiInstance.getRegistry(propertyClass, details, accept, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegistryApi#getRegistry");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
propertyClass String The fully qualified classname of the catalog type
details Boolean Add to include additional details, omit or false otherwise [optional]
accept String Override the 'Accept' request header (useful for debugging your requests) [optional] [enum: json, xml]
pretty Boolean Add to make the Web-API pretty print the response (useful for debugging your requests) [optional]

Return type

List<CatalogType>

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml