Web Services supports various get<Object> services that extract information in the form of an object. Information can be acquired from the Master Control File, Package File, or repository objects. The get<Object> service is based on CSV LIST requests and makes use of a native SOAP facility for creating objects to send and decoding the CSV output that is returned.
The get<Object> services are designed like the submitSCL service. Each get<Object> service retrieves a specific type of information. The <Object> part of the service name indicates the type of information that the service can retrieve. Each get<Object> service requires a corresponding SCL statement that has been appropriately coded to extract the requested information. Each get<Object> service returns an object designed from the information extracted by the Comma Separated Value (CSV) utility as directed by the SCL statement. The extracted information is converted into XML format and returned to the client.
In terms of object-oriented programming, the get<Object> service returns an array, designated as Object[]. Each entry in this array includes one occurrence of the retrieved objects and the object contains the requested information.
To view the property names that can be returned for each get<Object> service, see the WSDL file. For more information about the List statements and the corresponding returned property names and values, see the "Using the Comma Separated Values Utility" chapter in the Utilities Guide. The <Object> are built from the CSV representation, their properties map with the CSV layout. The property names match one by one with the CSV columns as described by the WSDL file.
The returned property names and values are the same as those returned by the CSV utility. However, in the case of an object (rather than a CSV request output) the properties are typed as string, integer, or date. The WSDL defines the type of each property. The date and time stamp is the external representation of the CA Endevor SCM stamp coded using the z/OS time zone.
Note: For more information about the Web Services component, see the chapter "Web Services" in the Scenario Guide. This same content can be found in the scenario How to Enable Web Services, which is accessible from the Knowledge Based Articles section on the documentation bookshelf.
|
Copyright © 2014 CA.
All rights reserved.
|
|