Class ProjectManagementResource
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.projectmanagement.server.spring.ProjectManagementResource
-
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/project-management/users/{userId}") public class ProjectManagementResource extends ObjectThe ProjectManagementResource provides the server-side implementation of the Project Management Open Metadata Assess Service (OMAS).
-
-
Constructor Summary
Constructors Constructor Description ProjectManagementResource()Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VoidResponseclearAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, ExternalSourceRequestBody requestBody)Remove an "AssignmentScope" relationship between two referenceables.VoidResponseclearMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, ExternalSourceRequestBody requestBody)Remove a "MoreInformation" relationship between two referenceables.VoidResponseclearProjectManagementRole(String serverName, String userId, String projectGUID, String projectRoleGUID, ExternalSourceRequestBody requestBody)Remove a membership relationship between a project and a person role.VoidResponseclearProjectTeam(String serverName, String userId, String projectGUID, String actorProfileGUID, ExternalSourceRequestBody requestBody)Remove a relationship between a project and a person role.VoidResponseclearResource(String serverName, String userId, String elementGUID, String resourceGUID, ExternalSourceRequestBody requestBody)Remove a "ResourceList" relationship between two referenceables.VoidResponseclearStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, ExternalSourceRequestBody requestBody)Remove a "Stakeholder" relationship between two referenceables.GUIDResponsecreateProject(String serverName, String userId, ReferenceableRequestBody requestBody)Create a new metadata element to represent a project.GUIDResponsecreateProjectFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody)Create a new metadata element to represent a project using an existing metadata element as a template.ProjectListResponsefindProjects(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)Retrieve the list of project metadata elements that contain the search string.RelatedElementListResponsegetAssignedActors(String serverName, String userId, String scopeGUID, int startFrom, int pageSize)Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.RelatedElementListResponsegetAssignedScopes(String serverName, String userId, String elementGUID, int startFrom, int pageSize)Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.RelatedElementListResponsegetDescriptiveElements(String serverName, String userId, String detailGUID, int startFrom, int pageSize)Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.RelatedElementListResponsegetMoreInformation(String serverName, String userId, String elementGUID, int startFrom, int pageSize)Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.ActorProfileListResponsegetProjectActors(String serverName, String userId, String projectGUID, int startFrom, int pageSize)Return information about the actors linked to a project.ProjectResponsegetProjectByGUID(String serverName, String userId, String guid)Retrieve the project metadata element with the supplied unique identifier.PersonRoleListResponsegetProjectManagementRoles(String serverName, String userId, String projectGUID, int startFrom, int pageSize)Return information about a person role connected to the named project.ProjectListResponsegetProjectsByName(String serverName, String userId, int startFrom, int pageSize)Retrieve the list of project metadata elements.ProjectListResponsegetProjectsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)Retrieve the list of project metadata elements with a matching qualified or display name.RelatedElementListResponsegetResourceList(String serverName, String userId, String elementGUID, int startFrom, int pageSize)Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.RelatedElementListResponsegetStakeholderCommissionedElements(String serverName, String userId, String stakeholderGUID, int startFrom, int pageSize)Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.RelatedElementListResponsegetStakeholders(String serverName, String userId, String elementGUID, int startFrom, int pageSize)Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.RelatedElementListResponsegetSupportedByResource(String serverName, String userId, String resourceGUID, int startFrom, int pageSize)Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.VoidResponseremoveProject(String serverName, String userId, String projectGUID, ExternalSourceRequestBody requestBody)Remove the metadata element representing a project.VoidResponsesetupAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, RelationshipRequestBody requestBody)Create an "AssignmentScope" relationship between an element and its scope.VoidResponsesetupMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, RelationshipRequestBody requestBody)Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.VoidResponsesetupProjectManagementRole(String serverName, String userId, String projectGUID, String projectRoleGUID, RelationshipRequestBody requestBody)Create a membership relationship between a project and a person role to show that anyone appointed to the role is a member of the project.VoidResponsesetupProjectTeam(String serverName, String userId, String projectGUID, String actorProfileGUID, RelationshipRequestBody requestBody)Create a project team relationship between a project and a person role to show that anyone appointed to the role is a member of the project.VoidResponsesetupResource(String serverName, String userId, String elementGUID, String resourceGUID, RelationshipRequestBody requestBody)Create a "ResourceList" relationship between a consuming element and an element that represents resources.VoidResponsesetupStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, RelationshipRequestBody requestBody)Create a "Stakeholder" relationship between an element and its stakeholder.VoidResponseupdateProject(String serverName, String userId, String projectGUID, boolean isMergeUpdate, ReferenceableRequestBody requestBody)Update the metadata element representing a project.
-
-
-
Method Detail
-
createProject
@PostMapping(path="/projects") public GUIDResponse createProject(@PathVariable String serverName, @PathVariable String userId, @RequestBody ReferenceableRequestBody requestBody)
Create a new metadata element to represent a project.- Parameters:
serverName- name of the service to route the request to.userId- calling userrequestBody- properties to store- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
createProjectFromTemplate
@PostMapping(path="/projects/from-template/{templateGUID}") public GUIDResponse createProjectFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestBody TemplateRequestBody requestBody)Create a new metadata element to represent a project using an existing metadata element as a template.- Parameters:
serverName- name of the service to route the request to.userId- calling usertemplateGUID- unique identifier of the metadata element to copyrequestBody- properties that override the template- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
updateProject
@PostMapping(path="/projects/{projectGUID}") public VoidResponse updateProject(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @RequestParam boolean isMergeUpdate, @RequestBody ReferenceableRequestBody requestBody)Update the metadata element representing a project.- Parameters:
serverName- name of the service to route the request to.userId- calling userprojectGUID- unique identifier of the metadata element to updateisMergeUpdate- should the new properties be merged with the existing properties of overlay them?requestBody- new properties for this element- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
setupProjectManagementRole
@PostMapping(path="/projects/{projectGUID}/project-management-roles/{projectRoleGUID}") public VoidResponse setupProjectManagementRole(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @PathVariable String projectRoleGUID, @RequestBody RelationshipRequestBody requestBody)Create a membership relationship between a project and a person role to show that anyone appointed to the role is a member of the project.- Parameters:
serverName- name of the service to route the request to.userId- calling userprojectGUID- unique identifier of the projectprojectRoleGUID- unique identifier of the person rolerequestBody- external identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
clearProjectManagementRole
@PostMapping(path="/projects/{projectGUID}/project-management-roles/{projectRoleGUID}/delete") public VoidResponse clearProjectManagementRole(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @PathVariable String projectRoleGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove a membership relationship between a project and a person role.- Parameters:
serverName- name of the service to route the request to.userId- calling userprojectGUID- unique identifier of the projectprojectRoleGUID- unique identifier of the person rolerequestBody- external identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
setupProjectTeam
@PostMapping(path="/projects/{projectGUID}/project-teams/{actorProfileGUID}") public VoidResponse setupProjectTeam(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @PathVariable String actorProfileGUID, @RequestBody RelationshipRequestBody requestBody)Create a project team relationship between a project and a person role to show that anyone appointed to the role is a member of the project.- Parameters:
serverName- name of the service to route the request to.userId- calling userprojectGUID- unique identifier of the projectactorProfileGUID- unique identifier of the actorrequestBody- external identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
clearProjectTeam
@PostMapping(path="/projects/{projectGUID}/project-teams/{actorProfileGUID}/delete") public VoidResponse clearProjectTeam(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @PathVariable String actorProfileGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove a relationship between a project and a person role.- Parameters:
serverName- name of the service to route the request to.userId- calling userprojectGUID- unique identifier of the projectactorProfileGUID- unique identifier of the actorrequestBody- external source identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
removeProject
@PostMapping(path="/projects/{projectGUID}/delete") public VoidResponse removeProject(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove the metadata element representing a project.- Parameters:
serverName- name of the service to route the request to.userId- calling userprojectGUID- unique identifier of the metadata element to removerequestBody- external source identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
findProjects
@PostMapping(path="/projects/by-search-string") public ProjectListResponse findProjects(@PathVariable String serverName, @PathVariable String userId, @RequestBody SearchStringRequestBody requestBody, @RequestParam int startFrom, @RequestParam int pageSize)
Retrieve the list of project metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName- name of the service to route the request to.userId- calling userrequestBody- string to find in the propertiesstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
getProjectsByName
@PostMapping(path="/projects/by-name") public ProjectListResponse getProjectsByName(@PathVariable String serverName, @PathVariable String userId, @RequestBody NameRequestBody requestBody, @RequestParam int startFrom, @RequestParam int pageSize)
Retrieve the list of project metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName- name of the service to route the request to.userId- calling userrequestBody- name to search forstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
getProjectManagementRoles
@GetMapping(path="/project-managers/by-project/{projectGUID}") public PersonRoleListResponse getProjectManagementRoles(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @RequestParam int startFrom, @RequestParam int pageSize)Return information about a person role connected to the named project.- Parameters:
serverName- called serveruserId- calling userprojectGUID- unique identifier for the projectstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem
-
getProjectActors
@GetMapping(path="/project-actors/by-project/{projectGUID}") public ActorProfileListResponse getProjectActors(@PathVariable String serverName, @PathVariable String userId, @PathVariable String projectGUID, @RequestParam int startFrom, @RequestParam int pageSize)Return information about the actors linked to a project.- Parameters:
serverName- called serveruserId- calling userprojectGUID- unique identifier for the projectstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem
-
getProjectsByName
@GetMapping(path="/projects") public ProjectListResponse getProjectsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize)
Retrieve the list of project metadata elements.- Parameters:
serverName- name of the service to route the request to.userId- calling userstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
getProjectByGUID
@GetMapping(path="/projects/{guid}") public ProjectResponse getProjectByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)Retrieve the project metadata element with the supplied unique identifier.- Parameters:
serverName- name of the service to route the request to.userId- calling userguid- unique identifier of the requested metadata element- Returns:
- matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
setupMoreInformation
@PostMapping(path="/related-elements/{elementGUID}/more-information/{detailGUID}") public VoidResponse setupMoreInformation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String detailGUID, @RequestBody RelationshipRequestBody requestBody)Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the element that is descriptivedetailGUID- unique identifier of the element that provides the detailrequestBody- relationship properties- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearMoreInformation
@PostMapping(path="/related-elements/{elementGUID}/more-information/{detailGUID}/delete") public VoidResponse clearMoreInformation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String detailGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove a "MoreInformation" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the element that is descriptivedetailGUID- unique identifier of the element that provides the detailrequestBody- external source identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getMoreInformation
@GetMapping(path="/related-elements/more-information/by-descriptive-element/{elementGUID}") public RelatedElementListResponse getMoreInformation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the element that is descriptivestartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getDescriptiveElements
@GetMapping(path="/related-elements/more-information/by-detail-element/{detailGUID}") public RelatedElementListResponse getDescriptiveElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String detailGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userdetailGUID- unique identifier of the element that provides the detailstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupStakeholder
@PostMapping(path="/related-elements/{elementGUID}/stakeholders/{stakeholderGUID}") public VoidResponse setupStakeholder(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String stakeholderGUID, @RequestBody RelationshipRequestBody requestBody)Create a "Stakeholder" relationship between an element and its stakeholder.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementstakeholderGUID- unique identifier of the stakeholderrequestBody- relationship properties- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearStakeholder
@PostMapping(path="/related-elements/{elementGUID}/stakeholders/{stakeholderGUID}/delete") public VoidResponse clearStakeholder(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String stakeholderGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove a "Stakeholder" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementstakeholderGUID- unique identifier of the stakeholderrequestBody- external source identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getStakeholders
@GetMapping(path="/related-elements/stakeholders/by-commissioned-element/{elementGUID}") public RelatedElementListResponse getStakeholders(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getStakeholderCommissionedElements
@GetMapping(path="/related-elements/stakeholders/by-stakeholder/{stakeholderGUID}") public RelatedElementListResponse getStakeholderCommissionedElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String stakeholderGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userstakeholderGUID- unique identifier of the stakeholderstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupAssignmentScope
@PostMapping(path="/related-elements/{elementGUID}/assignment-scopes/{scopeGUID}") public VoidResponse setupAssignmentScope(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String scopeGUID, @RequestBody RelationshipRequestBody requestBody)Create an "AssignmentScope" relationship between an element and its scope.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementscopeGUID- unique identifier of the scoperequestBody- relationship properties- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearAssignmentScope
@PostMapping(path="/related-elements/{elementGUID}/assignment-scopes/{scopeGUID}/delete") public VoidResponse clearAssignmentScope(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String scopeGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove an "AssignmentScope" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementscopeGUID- unique identifier of the scoperequestBody- external source identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getAssignedScopes
@GetMapping(path="/related-elements/assignment-scopes/by-assigned-actor/{elementGUID}") public RelatedElementListResponse getAssignedScopes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getAssignedActors
@GetMapping(path="/related-elements/assignment-scopes/by-assigned-scope/{scopeGUID}") public RelatedElementListResponse getAssignedActors(@PathVariable String serverName, @PathVariable String userId, @PathVariable String scopeGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userscopeGUID- unique identifier of the scopestartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupResource
@PostMapping(path="/related-elements/{elementGUID}/resource-list/{resourceGUID}") public VoidResponse setupResource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody RelationshipRequestBody requestBody)Create a "ResourceList" relationship between a consuming element and an element that represents resources.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementresourceGUID- unique identifier of the resourcerequestBody- relationship properties- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearResource
@PostMapping(path="/related-elements/{elementGUID}/resource-list/{resourceGUID}/delete") public VoidResponse clearResource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody ExternalSourceRequestBody requestBody)Remove a "ResourceList" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementresourceGUID- unique identifier of the resourcerequestBody- external source identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getResourceList
@GetMapping(path="/related-elements/resource-list/by-assignee/{elementGUID}") public RelatedElementListResponse getResourceList(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userelementGUID- unique identifier of the elementstartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSupportedByResource
@GetMapping(path="/related-elements/resource-list/by-resource/{resourceGUID}") public RelatedElementListResponse getSupportedByResource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String resourceGUID, @RequestParam int startFrom, @RequestParam int pageSize)Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.- Parameters:
serverName- name of the service to route the request to.userId- calling userresourceGUID- unique identifier of the resourcestartFrom- index of the list to start from (0 for start)pageSize- maximum number of elements to return.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
-