Package org.odpi.openmetadata.accessservices.governanceprogram.server.spring

Class GovernanceExternalReferenceResource

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.server.spring.GovernanceExternalReferenceResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-program/users/{userId}")
public class GovernanceExternalReferenceResource
extends Object

GovernanceExternalReferenceResource sets up the external references that are part of an organization governance.

Constructor Summary

Constructors

Constructor	Description
GovernanceExternalReferenceResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
GUIDResponse	createExternalReference(String serverName, String userId, ReferenceableRequestBody requestBody)	Create a definition of an external reference.
VoidResponse	deleteExternalReference(String serverName, String userId, String externalReferenceGUID, ExternalSourceRequestBody requestBody)	Remove the definition of an external reference.
ExternalReferenceListResponse	findExternalReferencesById(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)	Retrieve the list of external references for this resourceId.
RelatedElementListResponse	getElementsForExternalReference(String serverName, String userId, String externalReferenceGUID, int startFrom, int pageSize)	Return information about the elements linked to a externalReference.
ExternalReferenceResponse	getExternalReferenceByGUID(String serverName, String userId, String externalReferenceGUID)	Return information about a specific external reference.
ExternalReferenceListResponse	getExternalReferencesByURL(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)	Retrieve the list of external references for this URL.
VoidResponse	linkExternalReferenceToElement(String serverName, String userId, String attachedToGUID, String externalReferenceGUID, RelationshipRequestBody requestBody)	Link an external reference to an object.
ExternalReferenceListResponse	retrieveAttachedExternalReferences(String serverName, String userId, String attachedToGUID, int startFrom, int pageSize)	Retrieve the list of external references attached to the supplied object.
VoidResponse	unlinkExternalReferenceFromElement(String serverName, String userId, String attachedToGUID, String externalReferenceGUID, RelationshipRequestBody requestBody)	Remove the link between an external reference and an element.
VoidResponse	updateExternalReference(String serverName, String userId, String externalReferenceGUID, boolean isMergeUpdate, ReferenceableRequestBody requestBody)	Update the definition of an external reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceExternalReferenceResource

public GovernanceExternalReferenceResource()

Default constructor

Method Detail

createExternalReference

@PostMapping(path="/external-references")
public GUIDResponse createExternalReference(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @RequestBody
                                            ReferenceableRequestBody requestBody)

Create a definition of an external reference.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

requestBody - properties for an external reference plus optional element to link the external reference to that will act as an anchor - that is, this external reference will be deleted when the element is deleted (once the external reference is linked to the anchor).

Returns:

unique identifier of the external reference or InvalidParameterException qualifiedName or userId is null; qualifiedName is not unique PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

updateExternalReference

@PostMapping(path="/external-references/{externalReferenceGUID}/update")
public VoidResponse updateExternalReference(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String externalReferenceGUID,
                                            @RequestParam
                                            boolean isMergeUpdate,
                                            @RequestBody
                                            ReferenceableRequestBody requestBody)

Update the definition of an external reference.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

externalReferenceGUID - unique identifier of external reference

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

requestBody - properties to change

Returns:

void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

deleteExternalReference

@PostMapping(path="/external-references/{externalReferenceGUID}/delete")
public VoidResponse deleteExternalReference(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String externalReferenceGUID,
                                            @RequestBody
                                            ExternalSourceRequestBody requestBody)

Remove the definition of an external reference.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

externalReferenceGUID - unique identifier of external reference

requestBody - external source request body

Returns:

void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

linkExternalReferenceToElement

@PostMapping(path="/elements/{attachedToGUID}/external-references/{externalReferenceGUID}/link")
public VoidResponse linkExternalReferenceToElement(@PathVariable
                                                   String serverName,
                                                   @PathVariable
                                                   String userId,
                                                   @PathVariable
                                                   String attachedToGUID,
                                                   @PathVariable
                                                   String externalReferenceGUID,
                                                   @RequestBody
                                                   RelationshipRequestBody requestBody)

Link an external reference to an object.

Parameters:

serverName - name of the server instance to connect to

userId - the name of the calling user.

attachedToGUID - object linked to external references.

externalReferenceGUID - unique identifier (guid) of the external reference details.

requestBody - description for the reference from the perspective of the object that the reference is being attached to.

Returns:

void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

unlinkExternalReferenceFromElement

@PostMapping(path="/elements/{attachedToGUID}/external-references/{externalReferenceGUID}/unlink")
public VoidResponse unlinkExternalReferenceFromElement(@PathVariable
                                                       String serverName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String attachedToGUID,
                                                       @PathVariable
                                                       String externalReferenceGUID,
                                                       @RequestBody
                                                       RelationshipRequestBody requestBody)

Remove the link between an external reference and an element. If the element is its anchor, the external reference is removed.

Parameters:

serverName - name of the server instance to connect to

userId - the name of the calling user.

attachedToGUID - object linked to external references.

externalReferenceGUID - identifier of the external reference.

requestBody - external source request body

Returns:

void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getExternalReferenceByGUID

@GetMapping(path="/external-references/{externalReferenceGUID}")
public ExternalReferenceResponse getExternalReferenceByGUID(@PathVariable
                                                            String serverName,
                                                            @PathVariable
                                                            String userId,
                                                            @PathVariable
                                                            String externalReferenceGUID)

Return information about a specific external reference.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

externalReferenceGUID - unique identifier for the external reference

Returns:

properties of the external reference or InvalidParameterException externalReferenceGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

findExternalReferencesById

@PostMapping(path="/external-references/by-resource-id")
public ExternalReferenceListResponse findExternalReferencesById(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @RequestParam
                                                                int startFrom,
                                                                @RequestParam
                                                                int pageSize,
                                                                @RequestBody
                                                                SearchStringRequestBody requestBody)

Retrieve the list of external references for this resourceId.

Parameters:

serverName - name of the server instance to connect to

userId - the name of the calling user.

requestBody - unique reference id assigned by the resource owner (supports wildcards). This is the qualified name of the entity

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

links to addition information or InvalidParameterException externalReferenceGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getExternalReferencesByURL

@PostMapping(path="/external-references/by-url")
public ExternalReferenceListResponse getExternalReferencesByURL(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @RequestParam
                                                                int startFrom,
                                                                @RequestParam
                                                                int pageSize,
                                                                @RequestBody
                                                                NameRequestBody requestBody)

Retrieve the list of external references for this URL.

Parameters:

serverName - name of the server instance to connect to

userId - the name of the calling user.

requestBody - URL of the external resource.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

links to addition information or InvalidParameterException externalReferenceGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

retrieveAttachedExternalReferences

@GetMapping(path="/elements/{attachedToGUID}/external-references")
public ExternalReferenceListResponse retrieveAttachedExternalReferences(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        String attachedToGUID,
                                                                        @RequestParam
                                                                        int startFrom,
                                                                        @RequestParam
                                                                        int pageSize)

Retrieve the list of external references attached to the supplied object.

Parameters:

serverName - name of the server instance to connect to

userId - the name of the calling user.

attachedToGUID - object linked to external reference.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

links to addition information or InvalidParameterException externalReferenceGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getElementsForExternalReference

@GetMapping(path="/elements/external-references/{externalReferenceGUID}")
public RelatedElementListResponse getElementsForExternalReference(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String externalReferenceGUID,
                                                                  @RequestParam
                                                                  int startFrom,
                                                                  @RequestParam
                                                                  int pageSize)

Return information about the elements linked to a externalReference.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

externalReferenceGUID - unique identifier for the externalReference

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the external reference InvalidParameterException externalReferenceGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem