INQUIRE WEBSERVICE

Description

Use the INQUIRE WEBSERVICE command to retrieve information about an installed web service.

Browsing

You can browse through all the web services installed in your system by using the browse options, START, NEXT, and END, on INQUIRE WEBSERVICE commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The resource signature

You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Auditing resources. The resource signature fields are BUNDLE, CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

ARCHIVEFILE(data-area)

Returns the name of an archive file that contains one or more WSDL files. The name can be up to 255 characters in length.

BINDING(data-area)

Returns the WSDL binding represented by the WEBSERVICE resource. This binding is one of (potentially) many that appear in the WSDL file. The name can be up to 255 characters long.

CCSID(data-area)

Returns the CCSID that is used to encode the character data in the application data structure at run time. This value is set using the optional CCSID parameter in the web services assistant when the web service binding file was generated. If the data-area is 0, the default CCSID for the CICS® region that is specified by the LOCALCCSID system initialization parameter is used.

CHANGEAGENT(cvda)

Returns a CVDA value that identifies the agent that made the last change to the resource definition. The possible values are as follows:

CREATESPI

The resource definition was last changed by an EXEC CICS CREATE command.

CSDAPI

The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.

CSDBATCH

The resource definition was last changed by a DFHCSDUP job.

DREPAPI

The resource definition was last changed by a CICSPlex SM BAS API command.

DYNAMIC

The resource definition was last changed by a PIPELINE scan.

CHANGEAGREL(data-area)

Returns a 4-digit number of the CICS release that was running when the resource definition was last changed.

CHANGETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.

CHANGEUSRID(data-area)

Returns the 8-character user ID that ran the change agent.

CONTAINER(data-area)

Returns the name of the container used if the PGMINTERFACE option returns a value of CHANNEL. The name can be up to 16 characters long.

DEFINESOURCE(data-area)

Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.

DEFINETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was created.

ENDPOINT(data-area)

Returns the endpoint URI of a remote web service. This endpoint URI is specified in the WSDL file for a remote web service. For provider-mode WEBSERVICE resources, this option is either empty or meaningless. The URI can be up to 255 characters long.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. The possible values are as follows:

BUNDLE

The resource was installed by a bundle deployment.

CREATESPI

The resource was installed by an EXEC CICS CREATE command.

CSDAPI

The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.

DYNAMIC

The resource was installed by using a PIPELINE scan.

GRPLIST

The resource was installed by GRPLIST INSTALL.

INSTALLTIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource was installed.

INSTALLUSRID(data-area)

Returns the 8-character user ID that installed the resource.

LASTMODTIME(data-area)

Returns the time, in milliseconds since 00:00 on January 1st 1900, that the deployed WSBind file on z/OS® UNIX was last updated. This value is a readonly value that CICS updates when the WEBSERVICE resource is installed or updated. The last-modified-time can be used to determine whether CICS has refreshed itself after an update is made to a WSBind file in the pickup directory.

• For dynamically-installed web services (those installed by the CICS scanning mechanism), the value of LASTMODTIME is the timestamp of the z/OS UNIX file pointed to by the WSBind definition, at the time the WEBSERVICE definition was last installed or updated.
• For statically installed web services (those installed from a CSD or by CREATE WEBSERVICE), the value of LASTMODTIME is the timestamp of the WSBind z/OS UNIX file pointed to by the WEBSERVICE definition, at the time that the web service was installed.

If you issue an INQUIRE WEBSERVICE command before a newly installed or updated web service has fully initialized, the returned LASTMODTIME value will be zero.

The value is returned in 8-byte packed-decimal form. You can use the EXEC CICS FORMATTIME command to convert the LASTMODTIME value to the date-and-time format that you prefer.

MAPPINGLEVEL(data-area)

Returns an 8-byte character string of the mapping level that is used to convert data between language structures and web service description (WSDL) documents. The value of the mapping level is 1.0, 1.1, 1.2, 2.0, ,2.1, 3.0, 4.0, or 4.1.

MAPPINGRNUM(data-area)

Returns a fullword binary value of the release number for the mapping level that is used to convert data between language structures and web service description (WSDL) documents. The value of the release number is 0, 1, or 2.

MAPPINGVNUM(data-area)

Returns a fullword binary value of the version number for the mapping level that is used to convert data between language structures and web service description (WSDL) documents. The value of the version number is 1, 2, 3 or 4.

MINRUNLEVEL(data-area)

Returns an 8-byte character string of the minimum runtime level that is required to run the web service in CICS. The value of the runtime level is 1.0, 1.1, 1.2, 2.0, ,2.1, 3.0, 4.0, or 4.1.

MINRUNRNUM(data-area)

Returns a fullword binary value of the release number for the minimum runtime level that is required to run the web service in CICS. The value of the release number is 0, 1, 2, 3, or 4.

MINRUNVNUM(data-area)

Returns a fullword binary value of the version number for the minimum runtime level that is required to run the web service in CICS. The value of the version number is 1 or 2.

PGMINTERFACE(cvda)

Returns a CVDA indicating whether the CICS program that implements the web service expects input in a channel or in a COMMAREA. CDVA values are as follows:

CHANNEL

The program expects input in a channel.

COMMAREA

The program expects input in a COMMAREA.

NOTAPPLIC

PGMINTERFACE does not apply when the web service is a service requester.

PIPELINE(data-area)

Returns the name of the PIPELINE resource in which the web service is installed; that is, the name of the PIPELINE resource that contains this WEBSERVICE resource. The name can be up to 8 characters long.

PROGRAM(data-area)

Returns the name of a CICS program that implements the web service. If this WEBSERVICE resource represents a remote web service (that is, CICS is not the service provider), the PROGRAM option is empty. The name can be up to 8 characters long.

STATE(cvda)

Returns a CVDA indicating the state of the web service:

DISABLED

This state is only available for WEBSERVICE resources that are defined in a CICS bundle. The web service has completed quiescing and is not accepting new work.

DISABLING

This state is only available for WEBSERVICE resources that are defined in a CICS bundle. The web service is quiescing. It is not accepting new work, but is allowing currently-executing work to complete. When the web service is no longer in use, the state of the WEBSERVICE resource changes to DISABLED.

DISCARDING

A DISCARD command has been issued for the WEBSERVICE resource. The web service is quiescing. It is not accepting new work, but is allowing currently-executing work to complete. When the web service is no longer in use, discarding is complete for the WEBSERVICE resource.

INITING

The web service binding file and the WSDL file are being copied to the shelf.

INSERVICE

Resolution of the copy of the web service binding file (WSBIND) on the shelf has succeeded, and the web service is usable.

UNUSABLE

There is a problem with the web service binding file (WSBIND) for the resource, and the web service is unusable.

UPDATING

An update request for a WEBSERVICE is pending.

URIMAP(data-area)

Returns the name of a dynamically installed URIMAP definition if one is associated with this web service. If the web service was not installed by performing the SCAN function on a PIPELINE resource, or if the WEBSERVICE resource represents a remote web service, the URIMAP definition is empty. The name can be up to 8 characters long.

VALIDATIONST(cvda)

Returns a CVDA indicating whether full validation of SOAP messages is currently enabled for this web service. CDVA values are as follows:

VALIDATION

Full validation is enabled.

NOVALIDATION

Full validation is disabled.

WEBSERVICE(name)

Specifies the name of the web service about which you are inquiring. The name can be up to 32 characters long.

WSBIND(data-area)

Returns the name of the web service binding file. The name can be up to 255 characters long.

WSDLFILE(data-area)

Returns the name of the web service description file associated with the WEBSERVICE resource. The name can be up to 255 characters long.

XOPDIRECTST(cvda)

Returns a value that indicates whether the web service is currently able to handle XOP documents in direct mode. CDVA values are as follows:

NOXOPDIRECT

The web service cannot currently handle XOP documents and binary attachments directly. This value is true when the web service implementation does not support the direct handling of XOP documents and binary attachments, or web service validation is switched on.

XOPDIRECT

The web service can currently handle XOP documents and binary attachments directly. This value is true when the web service implementation supports the direct handling of XOP documents and web service validation is not switched on.

XOPSUPPORTST(cvda)

Returns a CVDA value that indicates whether the web service implementation can handle XOP documents and binary attachments in direct mode. The CVDA values are as follows:

NOXOPSUPPORT

The web service implementation does not support the direct handling of XOP documents and binary attachments.

XOPSUPPORT

The web service implementation supports the direct handling of XOP documents and binary attachments. This value is true for any web services that are generated and deployed using the web services assistant.

Conditions

NOTAUTH

RESP2 values:

100

The user associated with the issuing task is not authorized to use this command.

NOTFND

RESP2 values:

3

The web service cannot be found.