GlossaryAuthorViewGlossaryRESTResource (Glossary Author OMVS with Spring 2.8 API)

java.lang.Object
- org.odpi.openmetadata.viewservices.glossaryauthor.server.GlossaryAuthorViewGlossaryRESTResource

```
@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/view-services/glossary-author/users/{userId}/glossaries")
public class GlossaryAuthorViewGlossaryRESTResource
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 and Description

GlossaryAuthorViewGlossaryRESTResource()
Default constructor

Constructors
Constructor and Description
`GlossaryAuthorViewGlossaryRESTResource()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubjectAreaOMASAPIResponse<Glossary>`	`createGlossary(String serverName, String userId, Glossary suppliedGlossary)` Create a Glossary.
`SubjectAreaOMASAPIResponse<SubjectAreaOMASAPIResponse<Term>>`	`createMultipleTermsInAGlossary(String serverName, String userId, String guid, Term[] terms)` Create the supplied list of Terms in the glossary, identified by the supplied guid.
`SubjectAreaOMASAPIResponse<Glossary>`	`deleteGlossary(String serverName, String userId, String guid, Boolean isPurge)` Delete a Glossary instance
`SubjectAreaOMASAPIResponse<Glossary>`	`findGlossary(String serverName, String userId, String searchCriteria, Date asOfTime, int startingFrom, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty)` Find Glossary
`SubjectAreaOMASAPIResponse<BreadCrumb>`	`getBreadCrumbTrail(String serverName, String userId, String guid, String rootCategoryGuid, String leafCategoryGuid, String termGuid)` Get BreadCrumbTrail.
`SubjectAreaOMASAPIResponse<Glossary>`	`getGlossary(String serverName, String userId, String guid)` Get a glossary.
`SubjectAreaOMASAPIResponse<Category>`	`getGlossaryCategories(String serverName, String userId, String guid, String searchCriteria, Date asOfTime, Boolean onlyTop, Integer startingFrom, Integer pageSize, String sequencingOrder, String sequencingProperty)` Get the Categories owned by this glossary.
`SubjectAreaOMASAPIResponse<Relationship>`	`getGlossaryRelationships(String serverName, String userId, String guid, Date asOfTime, int startingFrom, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty)` Get Glossary relationships.
`SubjectAreaOMASAPIResponse<Term>`	`getGlossaryTerms(String serverName, String userId, String guid, String searchCriteria, Date asOfTime, Integer startingFrom, Integer pageSize, String sequencingOrder, String sequencingProperty)` Get terms that are owned by this glossary.
`SubjectAreaOMASAPIResponse<Glossary>`	`restoreGlossary(String serverName, String userId, String guid)` Restore a Glossary
`SubjectAreaOMASAPIResponse<Glossary>`	`updateGlossary(String serverName, String userId, String guid, Glossary suppliedGlossary, Boolean isReplace)` Update a Glossary

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GlossaryAuthorViewGlossaryRESTResource
```
public GlossaryAuthorViewGlossaryRESTResource()
```
  Default constructor

Method Detail

createGlossary
```
@PostMapping
public SubjectAreaOMASAPIResponse<Glossary> createGlossary(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @RequestBody
                                                                        Glossary suppliedGlossary)
```
Create a Glossary. There are specializations of glossaries that can also be created using this operation. To create a specialization, you should specify a nodeType other than Glossary in the supplied glossary.
Valid nodeTypes for this request are:
- Taxonomy to create a Taxonomy
- CanonicalGlossary to create a canonical glossary
- TaxonomyAndCanonicalGlossary to create a glossary that is both a taxonomy and a canonical glosary
- Glossary to create a glossary that is not a taxonomy or a canonical glossary
Parameters:

serverName - name of the local server.

userId - userid

suppliedGlossary - Glossary to create.

Returns:
response, when successful contains the created glossary. 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.
- ClassificationException Error processing a classification.
- StatusNotSupportedException A status value is not supported.

getGlossary

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

Get a glossary.

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the glossary to get

Returns:

response which when successful contains the glossary with the requested guid 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

findGlossary

@GetMapping
public SubjectAreaOMASAPIResponse<Glossary> findGlossary(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @RequestParam(value="searchCriteria",required=false)
                                                                     String searchCriteria,
                                                                     @RequestParam(value="asOfTime",required=false)
                                                                     Date asOfTime,
                                                                     @RequestParam(value="startingFrom",required=false,defaultValue="0")
                                                                     int startingFrom,
                                                                     @RequestParam(value="pageSize",required=false)
                                                                     Integer pageSize,
                                                                     @RequestParam(value="sequencingOrder",required=false)
                                                                     SequencingOrder sequencingOrder,
                                                                     @RequestParam(value="sequencingProperty",required=false)
                                                                     String sequencingProperty)

Find Glossary

Parameters:

serverName - local UI server name

userId - userid

searchCriteria - String expression matching Glossary property values .

asOfTime - the glossaries returned as they were at this time. null indicates at the current time.

startingFrom - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is no limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

A list of glossaries meeting the search Criteria

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.
FunctionNotSupportedException Function not supported.

getGlossaryRelationships

@GetMapping(path="/{guid}/relationships")
public SubjectAreaOMASAPIResponse<Relationship> getGlossaryRelationships(@PathVariable
                                                                                                                   String serverName,
                                                                                                                   @PathVariable
                                                                                                                   String userId,
                                                                                                                   @PathVariable
                                                                                                                   String guid,
                                                                                                                   @RequestParam(value="asOfTime",required=false)
                                                                                                                   Date asOfTime,
                                                                                                                   @RequestParam(value="startingFrom",required=false,defaultValue="0")
                                                                                                                   int startingFrom,
                                                                                                                   @RequestParam(value="pageSize",required=false)
                                                                                                                   Integer pageSize,
                                                                                                                   @RequestParam(value="sequencingOrder",required=false)
                                                                                                                   SequencingOrder sequencingOrder,
                                                                                                                   @RequestParam(value="sequencingProperty",required=false)
                                                                                                                   String sequencingProperty)

Get Glossary relationships. The server has a maximum page size defined, the number of relationships returned is limited by that maximum page size.

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the glossary to get

asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.

startingFrom - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request.

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

a response which when successful contains the glossary relationships when not successful the following Exception responses can occur

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

getGlossaryTerms

@GetMapping(path="/{guid}/terms")
public SubjectAreaOMASAPIResponse<Term> getGlossaryTerms(@PathVariable
                                                                                           String serverName,
                                                                                           @PathVariable
                                                                                           String userId,
                                                                                           @PathVariable
                                                                                           String guid,
                                                                                           @RequestParam(value="searchCriteria",required=false)
                                                                                           String searchCriteria,
                                                                                           @RequestParam(value="asOfTime",required=false)
                                                                                           Date asOfTime,
                                                                                           @RequestParam(value="startingFrom",required=false,defaultValue="0")
                                                                                           Integer startingFrom,
                                                                                           @RequestParam(value="pageSize",required=false)
                                                                                           Integer pageSize,
                                                                                           @RequestParam(value="sequencingOrder",required=false)
                                                                                           String sequencingOrder,
                                                                                           @RequestParam(value="sequencingProperty",required=false)
                                                                                           String sequencingProperty)

Get terms that are owned by this glossary. The server has a maximum page size defined, the number of terms returned is limited by that maximum page size.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the category to get terms

asOfTime - the terms returned as they were at this time. null indicates at the current time.

searchCriteria - String expression matching child Term property values.

startingFrom - the starting element number for this set of results. This is used when retrieving elements

pageSize - Return the maximum number of elements that can be returned on this request.

sequencingOrder - sequencing order

sequencingProperty - property used for sequencing.

Returns:

A list of terms owned by the glossary when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

getGlossaryCategories

@GetMapping(path="/{guid}/categories")
public SubjectAreaOMASAPIResponse<Category> getGlossaryCategories(@PathVariable
                                                                                                         String serverName,
                                                                                                         @PathVariable
                                                                                                         String userId,
                                                                                                         @PathVariable
                                                                                                         String guid,
                                                                                                         @RequestParam(value="searchCriteria",required=false)
                                                                                                         String searchCriteria,
                                                                                                         @RequestParam(value="asOfTime",required=false)
                                                                                                         Date asOfTime,
                                                                                                         @RequestParam(value="onlyTop",required=false,defaultValue="true")
                                                                                                         Boolean onlyTop,
                                                                                                         @RequestParam(value="startingFrom",required=false,defaultValue="0")
                                                                                                         Integer startingFrom,
                                                                                                         @RequestParam(value="pageSize",required=false)
                                                                                                         Integer pageSize,
                                                                                                         @RequestParam(value="sequencingOrder",required=false)
                                                                                                         String sequencingOrder,
                                                                                                         @RequestParam(value="sequencingProperty",required=false)
                                                                                                         String sequencingProperty)

Get the Categories owned by this glossary. The server has a maximum page size defined, the number of Categories returned is limited by that maximum page size.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the glossary to get terms

searchCriteria - String expression matching child Category property values.

asOfTime - the categories returned as they were at this time. null indicates at the current time.

onlyTop - when only the top categories (those categories without parents) are returned.

startingFrom - the starting element number for this set of results. This is used when retrieving elements

pageSize - the maximum number of elements that can be returned on this request.

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

A list of categories owned by the glossary when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

createMultipleTermsInAGlossary

@PostMapping(path="/{guid}/terms")
public SubjectAreaOMASAPIResponse<SubjectAreaOMASAPIResponse<Term>> createMultipleTermsInAGlossary(@PathVariable
                                                                                                                                      String serverName,
                                                                                                                                      @PathVariable
                                                                                                                                      String userId,
                                                                                                                                      @PathVariable
                                                                                                                                      String guid,
                                                                                                                                      @RequestBody
                                                                                                                                      Term[] terms)

Create the supplied list of Terms in the glossary, identified by the supplied guid. Each term does not need to specify a glossary.

Parameters:

serverName - local UI server name

userId - user identifier

guid - guid of the glossary under which the Terms will be created

terms - terms to create

Returns:

a response which when successful contains a list of the responses from the Term creates (successful or otherwise). The order of the responses is the same as the supplied terms order. when not successful the following Exception responses can occur

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

getBreadCrumbTrail

@GetMapping(path="/{guid}/breadcrumbs")
public SubjectAreaOMASAPIResponse<BreadCrumb> getBreadCrumbTrail(@PathVariable
                                                                                                         String serverName,
                                                                                                         @PathVariable
                                                                                                         String userId,
                                                                                                         @PathVariable
                                                                                                         String guid,
                                                                                                         @RequestParam(value="rootCategoryGuid",required=false)
                                                                                                         String rootCategoryGuid,
                                                                                                         @RequestParam(value="leafCategoryGuid",required=false)
                                                                                                         String leafCategoryGuid,
                                                                                                         @RequestParam(value="termGuid",required=false)
                                                                                                         String termGuid)

Get BreadCrumbTrail. The user interface experience can start with a particular Glossary, navigate to a child Category, then to another child category then to a categories term. When such a user interface navigation occurs, it is helpful for the user to be displayed a 'breadcrumb' trail of where they have been, showing how nested they are in the glossary artifacts. The Get BreadcrumbTrail API returns information that allows the user interface to easy construct a trail of breadcrumbs. Each breadcrumb contains

a displayName that is intended to be shown to the user
a guid that uniquely identifies a breadcrumb but is not intended to be shown to the user
a types, allowing the user interface to display an appropriate icon.
a path that can be used to determine all the elements in the breadcrumb

Parameters:

serverName - local UI server name

userId - user identifier

guid - Glossary guid.

rootCategoryGuid - root Category guid. If specified, the Category with this guid must reside in the supplied glossary

leafCategoryGuid - leaf Category guid. if specified, the Category with this guid must reside in the hierarchy under the root Category

termGuid - Term guid. If specified, the Term with this guid must be categorised by the rootCategory or the leafCategory if there is one, or if there are no categories owned by the Glossary.

Returns:

a response which when successful contains a list of breadcrumbs corresponding to the supplied guids. when not successful the following Exception responses can occur

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

updateGlossary

@PutMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> updateGlossary(@PathVariable
                                                                                       String serverName,
                                                                                       @PathVariable
                                                                                       String userId,
                                                                                       @PathVariable
                                                                                       String guid,
                                                                                       @RequestBody
                                                                                       Glossary suppliedGlossary,
                                                                                       @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                       Boolean isReplace)

Update a Glossary

If the caller has chosen to incorporate the glossary name in their Glossary Terms or Categories qualified name, renaming the glossary will cause those qualified names to mismatch the Glossary name. If the caller has chosen to incorporate the glossary qualifiedName in their Glossary Terms or Categories qualified name, changing the qualified name of the glossary will cause those qualified names to mismatch the Glossary name. Status is not updated using this call.

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the glossary to update

suppliedGlossary - glossary to update

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

a response which when successful contains the updated glossary when not successful the following Exception responses can occur

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

deleteGlossary
```
@DeleteMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> deleteGlossary(@PathVariable
                                                                                          String serverName,
                                                                                          @PathVariable
                                                                                          String userId,
                                                                                          @PathVariable
                                                                                          String guid,
                                                                                          @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                          Boolean isPurge)
```
Delete a Glossary instance
The deletion of a glossary is only allowed if there is no glossary content (i.e. no terms or categories).
There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional. Soft delete is the default.
A soft delete means that the glossary instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete. A hard delete means that the glossary will not exist after the operation. when not successful the following Exceptions can occur
Parameters:

serverName - local UI server name

userId - userid

guid - guid of the glossary to be deleted.

isPurge - true indicates a hard delete, false is a soft delete.

Returns:
a void response when not successful the following Exception responses can occur
- UnrecognizedGUIDException the supplied guid was not recognised
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
- InvalidParameterException one of the parameters is null or invalid.
- MetadataServerUncontactableException not able to communicate with a Metadata repository service. There is a problem retrieving properties from the metadata repository.
- EntityNotDeletedException a soft delete was issued but the glossary was not deleted.
- EntityNotPurgedException a hard delete was issued but the glossary was not purged

restoreGlossary
```
@PostMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Glossary> restoreGlossary(@PathVariable
                                                                                         String serverName,
                                                                                         @PathVariable
                                                                                         String userId,
                                                                                         @PathVariable
                                                                                         String guid)
```
Restore a Glossary
Restore allows the deleted Glossary to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Parameters:

serverName - local UI server name

userId - userid

guid - guid of the glossary to restore

Returns:
response which when successful contains the restored glossary when not successful the following Exception responses can occur
- UnrecognizedGUIDException the supplied guid was not recognised
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
- InvalidParameterException one of the parameters is null or invalid.
- MetadataServerUncontactableException not able to communicate with a Metadata repository service. There is a problem retrieving properties from the metadata repository.

Class GlossaryAuthorViewGlossaryRESTResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlossaryAuthorViewGlossaryRESTResource

Method Detail

createGlossary

getGlossary

findGlossary

getGlossaryRelationships

getGlossaryTerms

getGlossaryCategories

createMultipleTermsInAGlossary

getBreadCrumbTrail

updateGlossary

deleteGlossary

restoreGlossary