APPOBJ - Object section
This section identifies the object and optionally the request type. The buffer must contain an object section for all requests except a GET request. A buffer can contain more than one object section, but all object sections must be in contiguous storage; that is, they must follow one another. The part of the buffer containing object sections is pointed to by the APP_OBJ_TRIPLET in the fixed section. APPOBJ itself points to APPSEL, APPFLD, and APPDAT sections if they are specified in a send buffer.
If your send buffer does not contain an object section for a GET request, that is, it contains only the fixed section, the buffer that HCL Workload Automation for Z returns contains a description of all objects and all fields that are supported by the API for a GET request.
The object section has this format:
| Offsets | |||||
|---|---|---|---|---|---|
| Dec | Hex | Type | Len | Name | Description |
|
0 |
(0) |
STRUCTURE |
84 |
APPOBJ |
OBJECT SECTION |
|
0 |
(0) |
24 |
APPOBJ_ID | OBJECT IDENTIFIER | |
|
0 |
(0) |
CHARACTER |
16 |
APPOBJ_NAME | OBJECT NAME |
|
16 |
(10) |
CHARACTER |
8 |
APPOBJ_KEY_TYPE | KEY TYPE |
|
24 |
(18) |
12 |
APPOBJ_FLD_TRIPLET | FIELD SECTION TRIPLET | |
|
24 |
(18) |
SIGNED |
4 |
APPOBJ_FLD_OFF | OFFSET TO FIRST FIELD SECTION |
|
28 |
(1C) |
SIGNED |
4 |
APPOBJ_FLD_LEN | LENGTH OF A FIELD SECTION |
|
32 |
(20) |
SIGNED |
4 |
APPOBJ_FLD_NBR | NUMBER OF FIELD SECTIONS |
|
36 |
(24) |
12 |
APPOBJ_SEL_TRIPLET | SELECTION SECTION TRIPLET | |
|
36 |
(24) |
SIGNED |
4 |
APPOBJ_SEL_OFF | OFFSET TO FIRST SELECTION SECTION |
|
40 |
(28) |
SIGNED |
4 |
APPOBJ_SEL_LEN | LENGTH OF A SELECTION SECTION |
|
44 |
(2C) |
SIGNED |
4 |
APPOBJ_SEL_NBR | NUMBER OF SELECTION SECTIONS |
|
48 |
(30) |
12 |
APPOBJ_DAT_TRIPLET | DATA SECTION TRIPLET | |
|
48 |
(30) |
SIGNED |
4 |
APPOBJ_DAT_OFF | OFFSET TO FIRST DATA SECTION |
|
52 |
(34) |
SIGNED |
4 |
APPOBJ_DAT_LEN | LENGTH OF ALL DATA SECTIONS |
| 56 | (38) | SIGNED | 4 | APPOBJ_DAT_NBR | NUMBER OF DATA SECTIONS |
| 60 | (3C) | CHARACTER | 8 | APPOBJ_TYPE |
DIALOG DATA TYPE |
| 68 | (44) | SIGNED | 4 | APPOBJ_RET | *OBJECT LEVEL RETURN CODE |
| 72 | (48) | SIGNED | 4 | APPOBJ_RSN | *OBJECT LEVEL REASON CODE |
| 76 | (4C) | CHARACTER | 8 | APPOBJ_AUTH | *RACF AUTHORITY (READ or UPDATE) |
|
Note: Descriptions
prefixed with an asterisk (*) indicate fields that HCL Workload Automation for Z updates. |
|||||
- APPOBJ_NAME
- Identifies the object type. For a description of valid names, see Specifying object names.
- APPOBJ_KEY_TYPE
- Is the key type. If you set this field to blanks (X'40'), a default value is used. for a description of valid key types, see Specifying key types .
- APPOBJ_FLD_TRIPLET
- Contains the offset to the first APPFLD section, the length of each section, and the number of sections. If the APPOBJ_FLD_NBR field contains all binary zeros (X'00') for a GET request, HCL Workload Automation for Z returns all fields in the selected object instances.
- APPOBJ_SEL_TRIPLET
- Contains the offset to the first APPSEL section, the length of each section, and the number of sections. Set these fields to binary zeros (X'00') if there are no APPSEL sections.
- APPOBJ_DAT_TRIPLET
- Contains the offset to the first APPDAT section, the length of all sections, and the number of sections. Set these fields to binary zeros (X'00') if there are no APPDAT sections. HCL Workload Automation for Z updates these fields if data is returned for a GET request.
- APPOBJ_TYPE
- Is the request type for this object. If you set this field to blanks (X'40'), APP_TYPE determines the request type.
- APPOBJ_RET
- Is the object level return code that is set by HCL Workload Automation for Z. In the send buffer set this field to binary zeros (X'00'). For more information, see Return codes and reason codes generated by HCL Workload Automation for Z.
- APPOBJ_RSN
- Is the object level reason code that is set by HCL Workload Automation for Z. In the send buffer set this field to binary zeros (X'00'). For more information, see Return codes and reason codes generated by HCL Workload Automation for Z.
- APPOBJ_AUTH
- Is the access authority (read or update) that your ATP has to the specified object. For GET, PUT, and DEL requests, HCL Workload Automation for Z updates this field before the buffer is returned. It is not updated for a CREATE request. You could use APPOBJ_AUTH to establish your access by issuing a GET request for the object, before attempting further read or update requests. In the send buffer set this field to blanks (X'40').