Get the response schema of a service

Use the HTTP method GET to retrieve the response schema of a service.

zosConnect-2.0 Applies to zosConnect-2.0.

HTTP method

GET

URI

/zosConnect/services/{serviceName}/schema/response

If the 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.

Note: Added in V1.1.0 of the administration interface.

Description

Gets the response schema of the specified service.

Security

Users with Admin, Operations or Reader authority can get the request or response schema of a service, users with Invoke authority cannot. For more information about user authorization, see Overview of IBM z/OS Connect security.

Response body

{
<Response schema as returned by the service provider-specific data transformer>
}

Note:

In V1.0.0 of the administration interface, retrieving the schema requires the use of the action=getResponseSchema query string, which is not as light-weight as the URI approach added in V1.1.0 .

https://myhost:myport/zosConnect/services/myService?action=getRequestSchema

If you use the getRequestSchema call to find JSON schema files, zosconnect_zosConnectDataXform automatically appends _request to the service name.