Retrieving service information

z/OS® Connect provides an administration interface that you can use to discover services, retrieve details of a service, get service request or response schema, and complete other operations.

zosConnect-2.0 Applies to zosConnect-2.0.

You can use the z/OS Connect administration interface from any client that is running in a web, mobile, or cloud environment. Specific authority (Admin, Operations, Reader, or Invoke) is required depending on the operations.

The following examples demonstrate some of the calls that can be made by using the administration interface.

  • Discover services in the z/OS Connect configuration by using an HTTP GET request. For example,
    https://<host>:<port>/zosConnect/services
  • Retrieve details of a service. For example,
    https://<host>:<port>/zosConnect/services/<service_name>
  • Retrieve request or response schema. 
    https://<host>:<port>/zosConnect/services/<service_name>/schema/request
    https://<host>:<port>/zosConnect/services/<service_name>/schema/response
Note: If <service_name> contains forward slashes, they must be escaped by using %2F. For example, if the service name is MyService/v1, it must be provided as MyService%2Fv1.

For more information about the supported methods and operations by the service administration interface, see Administering services with the administration interface.