Package org.odpi.openmetadata.viewservices.glossaryauthor.server

Class GlossaryAuthorViewConfigRESTResource

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.server.GlossaryAuthorViewConfigRESTResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/view-services/glossary-author/users/{userId}/configs")
public class GlossaryAuthorViewConfigRESTResource
extends Object

The GlossaryAuthorRESTServicesInstance provides the org.odpi.openmetadata.viewservices.glossaryauthor.server implementation of the Glossary Author Open Metadata View Service (OMVS) for glossaries. This interface provides glossary authoring interfaces for subject area experts.

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewConfigRESTResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
SubjectAreaOMASAPIResponse<Config>	getGlossary(String serverName, String userId, String guid)	Get a config.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GlossaryAuthorViewConfigRESTResource

public GlossaryAuthorViewConfigRESTResource()

Default constructor

Method Details

getGlossary

@GetMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Config> getGlossary(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid)

Get a config.

Parameters:

serverName - local UI server name

userId - userid

guid - identifier of the configuration to get

Returns:

response which when successful contains the config when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata repository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised
• UnrecognizedGUIDException the supplied guid was not recognised
• FunctionNotSupportedException Function not supported