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

Class DisplayApplicationResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/data-manager/users/{userId}")
public class DisplayApplicationResource
extends Object
    DisplayApplicationResource is the server-side implementation of the Data Manager OMAS's support for forms, reports and queries. It matches the DisplayApplicationClient.

    • Constructor Detail

      • DisplayApplicationResource

        public DisplayApplicationResource()
        Default constructor

    • Method Detail

      • createForm

        @PostMapping(path="/forms")
public GUIDResponse createForm​(@PathVariable
                               String serverName,
                               @PathVariable
                               String userId,
                               @RequestParam
                               boolean applicationIsHome,
                               @RequestBody
                               FormRequestBody requestBody)
        Create a new metadata element to represent a form.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationIsHome - should the form be marked as owned by the application so others can not update?
        requestBody - 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)

      • createFormFromTemplate

        @PostMapping(path="/forms/by-template/{templateGUID}")
public GUIDResponse createFormFromTemplate​(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String templateGUID,
                                           @RequestParam
                                           boolean applicationIsHome,
                                           @RequestBody
                                           TemplateRequestBody requestBody)
        Create a new metadata element to represent a form using an existing metadata element as a template.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        templateGUID - unique identifier of the metadata element to copy
        applicationIsHome - should the form be marked as owned by the application so others can not update?
        requestBody - 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)

      • updateForm

        @PostMapping(path="/forms/{formGUID}")
public VoidResponse updateForm​(@PathVariable
                               String serverName,
                               @PathVariable
                               String userId,
                               @PathVariable
                               String formGUID,
                               @RequestParam
                               boolean isMergeUpdate,
                               @RequestBody
                               FormRequestBody requestBody)
        Update the metadata element representing a form.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        formGUID - unique identifier of the metadata element to update
        isMergeUpdate - 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)

      • publishForm

        @PostMapping(path="/forms/{formGUID}/publish")
public VoidResponse publishForm​(@PathVariable
                                String serverName,
                                @PathVariable
                                String userId,
                                @PathVariable
                                String formGUID,
                                @RequestBody(required=false)
                                NullRequestBody nullRequestBody)
        Update the zones for the form asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        formGUID - unique identifier of the metadata element to publish
        nullRequestBody - empty request body
        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)

      • withdrawForm

        @PostMapping(path="/forms/{formGUID}/withdraw")
public VoidResponse withdrawForm​(@PathVariable
                                 String serverName,
                                 @PathVariable
                                 String userId,
                                 @PathVariable
                                 String formGUID,
                                 @RequestBody(required=false)
                                 NullRequestBody nullRequestBody)
        Update the zones for the form asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the form is first created).
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        formGUID - unique identifier of the metadata element to withdraw
        nullRequestBody - empty request body
        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)

      • removeForm

        @PostMapping(path="/forms/{formGUID}/{qualifiedName}/delete")
public VoidResponse removeForm​(@PathVariable
                               String serverName,
                               @PathVariable
                               String userId,
                               @PathVariable
                               String formGUID,
                               @PathVariable
                               String qualifiedName,
                               @RequestBody
                               MetadataSourceRequestBody requestBody)
        Remove the metadata element representing a form.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        formGUID - unique identifier of the metadata element to remove
        qualifiedName - unique name of the metadata element to remove
        requestBody - 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)

      • findForms

        @PostMapping(path="/forms/by-search-string")
public FormsResponse findForms​(@PathVariable
                               String serverName,
                               @PathVariable
                               String userId,
                               @RequestBody
                               SearchStringRequestBody requestBody,
                               @RequestParam
                               int startFrom,
                               @RequestParam
                               int pageSize)
        Retrieve the list of form 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 user
        requestBody - string to find in the properties
        startFrom - paging start point
        pageSize - 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)

      • getFormsByName

        @PostMapping(path="/forms/by-name")
public FormsResponse getFormsByName​(@PathVariable
                                    String serverName,
                                    @PathVariable
                                    String userId,
                                    @RequestBody
                                    NameRequestBody requestBody,
                                    @RequestParam
                                    int startFrom,
                                    @RequestParam
                                    int pageSize)
        Retrieve the list of form 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 user
        requestBody - name to search for
        startFrom - paging start point
        pageSize - 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)

      • getFormsForApplication

        @GetMapping(path="/forms/applications/{applicationGUID}/{applicationName}")
public FormsResponse getFormsForApplication​(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String applicationGUID,
                                            @PathVariable
                                            String applicationName,
                                            @RequestParam
                                            int startFrom,
                                            @RequestParam
                                            int pageSize)
        Retrieve the list of forms created by this caller.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationGUID - unique identifier of software server capability representing the application
        applicationName - unique name of software server capability representing the application
        startFrom - paging start point
        pageSize - 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)

      • getFormByGUID

        @GetMapping(path="/forms/{formGUID}")
public FormResponse getFormByGUID​(@PathVariable
                                  String serverName,
                                  @PathVariable
                                  String userId,
                                  @PathVariable
                                  String formGUID)
        Retrieve the form metadata element with the supplied unique identifier.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        formGUID - 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)

      • createReport

        @PostMapping(path="/reports")
public GUIDResponse createReport​(@PathVariable
                                 String serverName,
                                 @PathVariable
                                 String userId,
                                 @RequestParam
                                 boolean applicationIsHome,
                                 @RequestBody
                                 ReportRequestBody requestBody)
        Create a new metadata element to represent a report.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationIsHome - should the report be marked as owned by the application so others can not update?
        requestBody - 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)

      • createReportFromTemplate

        @PostMapping(path="/reports/from-template/{templateGUID}")
public GUIDResponse createReportFromTemplate​(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String templateGUID,
                                             @RequestParam
                                             boolean applicationIsHome,
                                             @RequestBody
                                             TemplateRequestBody requestBody)
        Create a new metadata element to represent a report using an existing metadata element as a template.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        templateGUID - unique identifier of the metadata element to copy
        applicationIsHome - should the report be marked as owned by the application so others can not update?
        requestBody - 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)

      • updateReport

        @PostMapping(path="/reports/{reportGUID}")
public VoidResponse updateReport​(@PathVariable
                                 String serverName,
                                 @PathVariable
                                 String userId,
                                 @PathVariable
                                 String reportGUID,
                                 @RequestParam
                                 boolean isMergeUpdate,
                                 @RequestBody
                                 ReportRequestBody requestBody)
        Update the metadata element representing a report.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        reportGUID - unique identifier of the metadata element to update
        isMergeUpdate - 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)

      • publishReport

        @PostMapping(path="/reports/{reportGUID}/publish")
public VoidResponse publishReport​(@PathVariable
                                  String serverName,
                                  @PathVariable
                                  String userId,
                                  @PathVariable
                                  String reportGUID,
                                  @RequestBody(required=false)
                                  NullRequestBody nullRequestBody)
        Update the zones for the report asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        reportGUID - unique identifier of the metadata element to publish
        nullRequestBody - empty request body
        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)

      • withdrawReport

        @PostMapping(path="/reports/{reportGUID}/withdraw")
public VoidResponse withdrawReport​(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String reportGUID,
                                   @RequestBody(required=false)
                                   NullRequestBody nullRequestBody)
        Update the zones for the report asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the report is first created).
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        reportGUID - unique identifier of the metadata element to withdraw
        nullRequestBody - empty request body
        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)

      • removeReport

        @PostMapping(path="/reports/{reportGUID}/{qualifiedName}/delete")
public VoidResponse removeReport​(@PathVariable
                                 String serverName,
                                 @PathVariable
                                 String userId,
                                 @PathVariable
                                 String reportGUID,
                                 @PathVariable
                                 String qualifiedName,
                                 @RequestBody
                                 MetadataSourceRequestBody requestBody)
        Remove the metadata element representing a report.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        reportGUID - unique identifier of the metadata element to remove
        qualifiedName - unique name of the metadata element to remove
        requestBody - 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)

      • findReports

        @PostMapping(path="/reports/by-search-string")
public ReportsResponse findReports​(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @RequestBody
                                   SearchStringRequestBody requestBody,
                                   @RequestParam
                                   int startFrom,
                                   @RequestParam
                                   int pageSize)
        Retrieve the list of report 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 user
        requestBody - string to find in the properties
        startFrom - paging start point
        pageSize - 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)

      • getReportsByName

        @PostMapping(path="/reports/by-name")
public ReportsResponse getReportsByName​(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @RequestBody
                                        NameRequestBody requestBody,
                                        @RequestParam
                                        int startFrom,
                                        @RequestParam
                                        int pageSize)
        Retrieve the list of report 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 user
        requestBody - name to search for
        startFrom - paging start point
        pageSize - 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)

      • getReportsForApplication

        @GetMapping(path="/reports/applications/{applicationGUID}/{applicationName}")
public ReportsResponse getReportsForApplication​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String applicationGUID,
                                                @PathVariable
                                                String applicationName,
                                                @RequestParam
                                                int startFrom,
                                                @RequestParam
                                                int pageSize)
        Retrieve the list of reports created by this caller.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationGUID - unique identifier of software server capability representing the application
        applicationName - unique name of software server capability representing the application
        startFrom - paging start point
        pageSize - 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)

      • getReportByGUID

        @GetMapping(path="/reports/{reportGUID}")
public ReportResponse getReportByGUID​(@PathVariable
                                      String serverName,
                                      @PathVariable
                                      String userId,
                                      @PathVariable
                                      String reportGUID)
        Retrieve the report metadata element with the supplied unique identifier.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        reportGUID - 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)

      • createQuery

        @PostMapping(path="/queries")
public GUIDResponse createQuery​(@PathVariable
                                String serverName,
                                @PathVariable
                                String userId,
                                @RequestParam
                                boolean applicationIsHome,
                                @RequestBody
                                QueryRequestBody requestBody)
        Create a new metadata element to represent a query.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationIsHome - should the query be marked as owned by the application so others can not update?
        requestBody - 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)

      • createQueryFromTemplate

        @PostMapping(path="/queries/from-template/{templateGUID}")
public GUIDResponse createQueryFromTemplate​(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String templateGUID,
                                            @RequestParam
                                            boolean applicationIsHome,
                                            @RequestBody
                                            TemplateRequestBody requestBody)
        Create a new metadata element to represent a query using an existing metadata element as a template.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        templateGUID - unique identifier of the metadata element to copy
        applicationIsHome - should the query be marked as owned by the application so others can not update?
        requestBody - 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)

      • updateQuery

        @PostMapping(path="/queries/{queryGUID}")
public VoidResponse updateQuery​(@PathVariable
                                String serverName,
                                @PathVariable
                                String userId,
                                @PathVariable
                                String queryGUID,
                                @RequestParam
                                boolean isMergeUpdate,
                                @RequestBody
                                QueryRequestBody requestBody)
        Update the metadata element representing a query.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        queryGUID - unique identifier of the metadata element to update
        isMergeUpdate - 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)

      • publishQuery

        @PostMapping(path="/queries/{queryGUID}/publish")
public VoidResponse publishQuery​(@PathVariable
                                 String serverName,
                                 @PathVariable
                                 String userId,
                                 @PathVariable
                                 String queryGUID,
                                 @RequestBody(required=false)
                                 NullRequestBody nullRequestBody)
        Update the zones for the query asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        queryGUID - unique identifier of the metadata element to publish
        nullRequestBody - empty request body
        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)

      • withdrawQuery

        @PostMapping(path="/queries/{queryGUID}/withdraw")
public VoidResponse withdrawQuery​(@PathVariable
                                  String serverName,
                                  @PathVariable
                                  String userId,
                                  @PathVariable
                                  String queryGUID,
                                  @RequestBody(required=false)
                                  NullRequestBody nullRequestBody)
        Update the zones for the query asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the query is first created).
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        queryGUID - unique identifier of the metadata element to withdraw
        nullRequestBody - empty request body
        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)

      • removeQuery

        @PostMapping(path="/queries/{queryGUID}/{qualifiedName}/delete")
public VoidResponse removeQuery​(@PathVariable
                                String serverName,
                                @PathVariable
                                String userId,
                                @PathVariable
                                String queryGUID,
                                @PathVariable
                                String qualifiedName,
                                @RequestBody
                                MetadataSourceRequestBody requestBody)
        Remove the metadata element representing a query.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        queryGUID - unique identifier of the metadata element to remove
        qualifiedName - unique name of the metadata element to remove
        requestBody - 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)

      • findQueries

        @PostMapping(path="/queries/by-search-string")
public QueriesResponse findQueries​(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @RequestBody
                                   SearchStringRequestBody requestBody,
                                   @RequestParam
                                   int startFrom,
                                   @RequestParam
                                   int pageSize)
        Retrieve the list of query 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 user
        requestBody - string to find in the properties
        startFrom - paging start point
        pageSize - 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)

      • getQueriesByName

        @PostMapping(path="/queries/by-name")
public QueriesResponse getQueriesByName​(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @RequestBody
                                        NameRequestBody requestBody,
                                        @RequestParam
                                        int startFrom,
                                        @RequestParam
                                        int pageSize)
        Retrieve the list of query 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 user
        requestBody - name to search for
        startFrom - paging start point
        pageSize - 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)

      • getQueriesForApplication

        @GetMapping(path="/queries/applications/{applicationGUID}/{applicationName}")
public QueriesResponse getQueriesForApplication​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String applicationGUID,
                                                @PathVariable
                                                String applicationName,
                                                @RequestParam
                                                int startFrom,
                                                @RequestParam
                                                int pageSize)
        Retrieve the list of queries created by this caller.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationGUID - unique identifier of software server capability representing the application
        applicationName - unique name of software server capability representing the application
        startFrom - paging start point
        pageSize - 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)

      • getQueryByGUID

        @GetMapping(path="/queries/{queryGUID}")
public QueryResponse getQueryByGUID​(@PathVariable
                                    String serverName,
                                    @PathVariable
                                    String userId,
                                    @PathVariable
                                    String queryGUID)
        Retrieve the query metadata element with the supplied unique identifier.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        queryGUID - 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)

      • createDataContainer

        @PostMapping(path="/elements/{parentGUID}/data-containers")
public GUIDResponse createDataContainer​(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String parentGUID,
                                        @RequestParam
                                        boolean applicationIsHome,
                                        @RequestBody
                                        DataContainerRequestBody requestBody)
        Create a new metadata element to represent a data field.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        applicationIsHome - should the data field be marked as owned by the event broker so others can not update?
        parentGUID - unique identifier of the parent element where the schema is located
        requestBody - properties about the data field
        Returns:
        unique identifier of the new data field 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)

      • createDataContainerFromTemplate

        @PostMapping(path="/elements/{parentGUID}/data-containers/from-template/{templateGUID}")
public GUIDResponse createDataContainerFromTemplate​(@PathVariable
                                                    String serverName,
                                                    @PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String templateGUID,
                                                    @PathVariable
                                                    String parentGUID,
                                                    @RequestParam
                                                    boolean applicationIsHome,
                                                    @RequestBody
                                                    TemplateRequestBody requestBody)
        Create a new metadata element to represent a data field using an existing metadata element as a template.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        templateGUID - unique identifier of the metadata element to copy
        parentGUID - unique identifier of the parent where the schema is located
        applicationIsHome - should the data field be marked as owned by the event broker so others can not update?
        requestBody - properties that override the template
        Returns:
        unique identifier of the new data field 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)

      • updateDataContainer

        @PostMapping(path="/data-containers/{dataContainerGUID}")
public VoidResponse updateDataContainer​(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String dataContainerGUID,
                                        @RequestParam
                                        boolean isMergeUpdate,
                                        @RequestBody
                                        DataContainerRequestBody requestBody)
        Update the metadata element representing a data field.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        dataContainerGUID - unique identifier of the metadata element to update
        isMergeUpdate - are unspecified properties unchanged (true) or removed?
        requestBody - new properties for the metadata 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)

      • removeDataContainer

        @PostMapping(path="/data-containers/{dataContainerGUID}/delete")
public VoidResponse removeDataContainer​(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String dataContainerGUID,
                                        @PathVariable
                                        String qualifiedName,
                                        @RequestBody
                                        MetadataSourceRequestBody requestBody)
        Remove the metadata element representing a data container.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        dataContainerGUID - unique identifier of the metadata element to remove
        qualifiedName - unique name of the metadata element to remove
        requestBody - 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)

      • findDataContainers

        @PostMapping(path="/data-containers/by-search-string")
public DataContainersResponse findDataContainers​(@PathVariable
                                                 String serverName,
                                                 @PathVariable
                                                 String userId,
                                                 @RequestBody
                                                 SearchStringRequestBody requestBody,
                                                 @RequestParam
                                                 int startFrom,
                                                 @RequestParam
                                                 int pageSize)
        Retrieve the list of data field 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 user
        requestBody - string to find in the properties
        startFrom - paging start point
        pageSize - 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)

      • getDataContainersForParent

        @GetMapping(path="/data-containers/by-parent-element/{parentGUID}")
public DataContainersResponse getDataContainersForParent​(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String parentGUID,
                                                         @RequestParam
                                                         int startFrom,
                                                         @RequestParam
                                                         int pageSize)
        Return the list of schemas associated with a parent element .
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        parentGUID - unique identifier of the parent element to query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of metadata elements describing the schemas associated with the requested parent 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)

      • getDataContainersByName

        @PostMapping(path="/data-containers/by-name")
public DataContainersResponse getDataContainersByName​(@PathVariable
                                                      String serverName,
                                                      @PathVariable
                                                      String userId,
                                                      @RequestBody
                                                      NameRequestBody requestBody,
                                                      @RequestParam
                                                      int startFrom,
                                                      @RequestParam
                                                      int pageSize)
        Retrieve the list of data field 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 user
        requestBody - name to search for
        startFrom - paging start point
        pageSize - 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)

      • getDataContainerByGUID

        @GetMapping(path="/data-containers/{dataContainerGUID}")
public DataContainerResponse getDataContainerByGUID​(@PathVariable
                                                    String serverName,
                                                    @PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String dataContainerGUID)
        Retrieve the data field metadata element with the supplied unique identifier.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        dataContainerGUID - unique identifier of the requested metadata element
        Returns:
        requested 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)