Generic method responses for Db2

A successful response generates an HTTP status code of 200. Failures produce an appropriate status code and an error message describing the cause of the failure.

Z Data Tools Service Provider generates the following JSON format in response to a successful generic method request for Db2® data:

{
    "rows" :
    [
        {
            "last" : boolean,
            "columns" :
            [
                {
                    “column" : "string",
                    "type" : "string",
                    "dimension" : integer,
                    "value" : "string-number-array-or-null",
                    "error" : "string"
                }
            ]
        }
    ] ,
    "token" : "string"
}

Key fields for a generic method response are explained in the following table:

Key Description
rows An array of 0 or more rows from the Db2 data resource.
last If present, is indicates that the row is last in the Db2 result table.
columns Each row is represented as an array of 1 or more columns.
column The name of the Db2 resource column.
type The Z Data Tools data type of the column. For a list of data types, see Dynamic Template panel.
dimension If the column is an array, the dimension of the array. For example, a value of 2 represents a two-dimensional array.
value The column data value. A null value means the value could not be determined.
error Short error text explaining why the column value is null (that is, why the value could not be determined.
token A Z Data Tools session token. A token is returned when a request sets "session" : true and does not also pass a token value. The token represents a ZDT/Db2 session running in the z/OS® environment and can be used by subsequent requests when multiple accesses by a client are required.

To end the ZDT/Db2 session, the client must send a request with the token and "session" : false, otherwise the session will eventually time out if inactive.