API format

The format section in the API information shows the type of information to be returned by an API.

For example, for the Retrieve Job Description Information (QWDRJOBD) API, the format described is JOBD0100 Format. Listed within the format are the individual fields that contain the attributes of the job description. The offset in the Dec (decimal offset) column for the hold on job queue field (hold parameter on the Create Job Description (CRTJOBD) or Change Job Description (CHGJOBD) command) begins at decimal offset 76.

The fields in the format do not occur in any particular sequence. To determine what you want, you need to scan the format.

The QWDRJOBD API has only a single format; other APIs can have multiple formats where each format has different levels of information. With multiple formats, a format name parameter allows you to specify which format you want to retrieve.