WEBCONTAINER_ELEMENTS

Description

The stored procedure WEBCONTAINER_ELEMENTS returns information about the Web services (SOAP and REST) and widgets of all the Virtual DataPort databases. You can filter by database, type of Web service, name of the service, look only for services that are deployed, etc.

With the CATALOG_ELEMENTS procedure (see section CATALOG_ELEMENTS) you can also obtain a list of the existing Web services and widgets. The difference is that it only searches the database that you are currently connected to and it does not provide information about if they are deployed or not.

Syntax

WEBCONTAINER_ELEMENTS (
      input_database_name : text
    , <input_service>
    , <input_service_type>
    , input_service_name : text
    , input_description : text
    , input_modified : boolean
    , input_deployed : boolean
)

<input_service> ::=
      'webservice'
    | 'widget'

<input_service_type> ::=
      'REST'
    | 'SOAP'
    | 'SOAP/REST'

All the parameters are optional. If a parameter is NULL, the procedure does not filter by that parameter.

  • input_database_name: name of the database where you want to search for Web services and/or widgets. If NULL, it searches all the databases for services.
  • input_service: type of service you are looking for. The value is case insensitive.
    • To search for widgets, enter "widget".
    • To search for Web services, enter “webservice".
    • To search both, enter NULL.
  • input_service_type: type of service that you are looking for. Widgets do not have subtypes, so when you are looking for them, just enter the value widget in the service parameter and set this to NULL.
    • To search for REST Web services, enter "REST".
    • To search for SOAP Web services, enter "SOAP".
    • To search for Web services imported from Virtual DataPort 4.7 or earlier, enter "SOAP/REST".
  • input_service_name: if provided, the procedure returns the services whose name contains this value. Take into account that if the parameter input_database_name is NULL, the procedure returns the services of all the databases that match this name. Not just the one that you currently connected to.
  • input_description: if provided, the procedure returns the services whose description contains this value.
  • input_modified: if true, it returns all the services that are deployed and that have been modified after being deployed. If false, it returns all the services that are deployed and that have not been modified afterwards.
  • input_deployed: if true, it returns all the services that are deployed. If false, it returns the services that are not deployed.

Privileges Required

This procedure only returns information about the Web services and widgets that belong to databases on which the user is an administrator. The implications of this are the following:

  • If the user is an administrator, the procedure will return information about all the Web services and widgets.
  • The procedure will return information about the Web services and widgets of the databases of which the user is a local administrator.

This procedure does not return a “privileges error”. For example, let us say that:

  • A user requests information about the Web services of all the databases.
  • The Server has two databases: admin and testing.
  • This user only is a local administrator of the testing database but not the admin database.

In this scenario, the procedure only returns information about the Web services of the testing database and not about the Web services of the admin database.

Examples

Example 1

Obtain all the REST Web services of the database test:

CALL WEBCONTAINER_ELEMENTS('test', null, 'REST', null, null, null, null)

Example 2

Obtain all the deployed Web services and auxiliary Web services for widgets:

CALL WEBCONTAINER_ELEMENTS(null, null, null, null, null, null, true)

Example 3

Obtain all the deployed Web services whose definition has changed since they were deployed:

CALL WEBCONTAINER_ELEMENTS(null, null, null, null, null, true, true)

In this case, setting the last parameter (deployed) to true or NULL is equivalent because only deployed services can marked as modified.