Defining Selection Criteria

This section describes the service operations that are available for working with trees in the selection criteria. These include:

  • QAS SOAP based service

    • QAS_TREES_OPER

    • QAS_TREE_DETAILS_OPER

  • QAS RESTful based service

    • QAS_TREES_REST_GET

    • QAS_TREE_DETAILS_REST_GET

This service operation returns the list of PeopleSoft trees that are accessible to the user.

Request Message: QAS_TREES_REQ_MSG

Element Name

Description

SEARCH_STRING

Required element

Complete tree name or the first few letters of the name.

If no value is entered, a list of all accessible tress will be returned.

Example Request:

This request returns all trees that start with QE_J.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_TREES_REQ_MSG.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_TREES_REQ_MSG>
         <SEARCH_STRING>QE_J</SEARCH_STRING>
      </qas:QAS_TREES_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_ TREES_RESP_MSG

Element Name

Description

TREE_NAME

Tree name.

TREE_DESCRIPTION

Tree description.

TREE_SET_ID

Set ID.

TREE_SET_CONTROL_VALUE

Set control value.

TREE_EFFECTIVE_DATE

Effective date.

INFO_MESSAGE

Returns information about the request. For example if the criterion in the request is incorrect or if no trees meet the criteria, a message indicating the error is returned.

Example Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <qcs:QAS_TREES_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
       Enterprise/Tools/schemas/QAS_TREES_RESP_MSG.VERSION_1">
         <TREE>
            <TREE_NAME>QE_JOBCODES</TREE_NAME>
            <TREE_DESCRIPTION>JobCodes</TREE_DESCRIPTION>
            <TREE_SET_ID/>
            <TREE_SET_CONTROL_VALUE/>
            <TREE_EFFECTIVE_DATE>1999-01-01</TREE_EFFECTIVE_DATE>
         </TREE>
      </qcs:QAS_TREES_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>

This service operation returns the list of PeopleSoft trees that are accessible to the user.

Request Message: QAS_TREES_TEMPL

Element Name

Description

SEARCH_STRING

Required element

Complete tree name or the first few letters of the name.

If no value is entered, a list of all accessible tress will be returned.

Example Request:

This request returns all trees that start with QE_J.

https://<servername>:<port>/PSIGW/RESTListeningConnector/<default local node>/Trees.v1/gettrees?search=QE_J

Response Message: QAS_ TREES_REST_RESP_MSG

Element Name

Description

TREE_NAME

Tree name.

TREE_DESCRIPTION

Tree description.

TREE_SET_ID

Set ID.

TREE_SET_CONTROL_VALUE

Set control value.

TREE_EFFECTIVE_DATE

Effective date.

INFO_MESSAGE

Returns information about the request. For example if the criterion in the request is incorrect or if no trees meet the criteria, a message indicating the error is returned.

Example Response:

<?xml version="1.0"?>
<qcs:QAS_TREES_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
Enterprise/Tools/schemas/QAS_TREES_RESP_MSG.VERSION_1">
    <TREE>
        <TREE_NAME>QE_JOBCODES</TREE_NAME>
        <TREE_DESCRIPTION>JobCodes</TREE_DESCRIPTION>
        <TREE_SET_ID/>
        <TREE_SET_CONTROL_VALUE/>
        <TREE_EFFECTIVE_DATE>1999-01-01</TREE_EFFECTIVE_DATE>
    </TREE>
</qcs:QAS_TREES_RESP_MSG>

This service operation returns the tree details for a specific tree.

Request Message: QAS_TREE_DETAILS_REQ_MSG

Element Name

Description

TREE_NAME

Required element

Complete tree name. Required.

TREE_SET_ID

Required element

setID. Required.

TREE_SET_CONTROL

Required element

Set control value. Required.

TREE_EFFECTIVE_DATE

Required element

Effective date in YYYY-MM-DD format. Required.

INFO_MESSAGE

Returns information about the request. For example if the criterion in the request is incorrect or if no trees meet the criteria, a message indicating the error is returned.

Example Request:

This is an example of a request to retrieve tree details for the tree QE_JOBCODES.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_TREE_DETAILS_REQ_MSG.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_TREE_DETAILS_REQ_MSG>
         <TREE_NAME>QE_JOBCODES</TREE_NAME>
         <TREE_SET_ID/>
         <TREE_SET_CONTROL/>
        <TREE_EFFECTIVE_DATE>1999-01-01</TREE_EFFECTIVE_DATE>
</qas:QAS_TREE_DETAILS_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_TREE_DETAILS_RESP_MSG

Element Name

Description

TREE_NAME

Tree name.

NODE_NAME

Tree node name.

NODE_DESCRIPTION

Tree node description.

NODE_LEVEL

Tree node level.

PARENT_NODE

Parent node.

Example response:

This response is very long, so only a portion is shown.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <qcs:QAS_TREE_DETAILS_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
      Enterprise/Tools/schemas/QAS_TREE_DETAILS_RESP_MSG.VERSION_1">
         <TREE_NAME>QE_JOBCODES</TREE_NAME>
         <NODE>
            <NODE_LEVEL>1</NODE_LEVEL>
            <NODE_NAME>ALL_JOBS</NODE_NAME>
            <NODE_DESCRIPTION>All Job Codes</NODE_DESCRIPTION>
         </NODE>
         <NODE>
            <NODE_LEVEL>2</NODE_LEVEL>
            <NODE_NAME>EXECUTIVE</NODE_NAME>
            <NODE_DESCRIPTION>Executive</NODE_DESCRIPTION>
            <PARENT_NODE>ALL_JOBS</PARENT_NODE>
         </NODE>
         <NODE>
            <NODE_LEVEL>3</NODE_LEVEL>
            <NODE_NAME>VP</NODE_NAME>
            <NODE_DESCRIPTION>Vice President</NODE_DESCRIPTION>
            <PARENT_NODE>EXECUTIVE</PARENT_NODE>
         </NODE>
         ...  
      </qcs:QAS_TREE_DETAILS_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>

This service operation returns the tree details for a specific tree.

Request Message: QAS_TREE_DETAILS_TEMPL

Element Name

Description

TREE_NAME

Required element

Complete tree name. Required.

TREE_SET_ID

Required element

setID. Required.

TREE_SET_CONTROL

Required element

Set control value. Required.

TREE_EFFECTIVE_DATE

Required element

Effective date in YYYY-MM-DD format. Required.

INFO_MESSAGE

Returns information about the request. For example if the criterion in the request is incorrect or if no trees meet the criteria, a message indicating the error is returned.

Example Request:

This is an example of a request to retrieve tree details for the tree QE_JOBCODES.

https://<servername>:<port>/PSIGW/RESTListeningConnector/<default local node>/TreeDetails.v1/QE_JOBCODES?setid=&setcontrol=&effdt=1999-01-01

Response Message: QAS_TREE_DETAILS_RESP_MSG

Element Name

Description

TREE_NAME

Tree name.

NODE_NAME

Tree node name.

NODE_DESCRIPTION

Tree node description.

NODE_LEVEL

Tree node level.

PARENT_NODE

Parent node.

Example response:

This response is very long, so only a portion is shown.

<?xml version="1.0"?>
<qcs:QAS_TREE_DETAILS_RESP_MSG xmlns:qcs="http://xmlns.oracle.com/
Enterprise/Tools/schemas/QAS_TREE_DETAILS_RESP_MSG.VERSION_1">
    <TREE_NAME>QE_JOBCODES</TREE_NAME>
    <NODE>
        <NODE_LEVEL>1</NODE_LEVEL>
        <NODE_NAME>ALL_JOBS</NODE_NAME>
        <NODE_DESCRIPTION>All Job Codes</NODE_DESCRIPTION>
    </NODE>
    <NODE>
        <NODE_LEVEL>2</NODE_LEVEL>
        <NODE_NAME>EXECUTIVE</NODE_NAME>
        <NODE_DESCRIPTION>Executive</NODE_DESCRIPTION>
        <PARENT_NODE>ALL_JOBS</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>VP</NODE_NAME>
        <NODE_DESCRIPTION>Vice President</NODE_DESCRIPTION>
        <PARENT_NODE>EXECUTIVE</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>DIRECTOR</NODE_NAME>
        <NODE_DESCRIPTION>Director</NODE_DESCRIPTION>
        <PARENT_NODE>EXECUTIVE</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>OFFICER</NODE_NAME>
        <NODE_DESCRIPTION>Corporate Officer</NODE_DESCRIPTION>
        <PARENT_NODE>EXECUTIVE</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>2</NODE_LEVEL>
        <NODE_NAME>EXEMPT</NODE_NAME>
        <NODE_DESCRIPTION>Exempt</NODE_DESCRIPTION>
        <PARENT_NODE>ALL_JOBS</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>TECHNICAL</NODE_NAME>
        <NODE_DESCRIPTION>Technical</NODE_DESCRIPTION>
        <PARENT_NODE>EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>MANAGERIAL</NODE_NAME>
        <NODE_DESCRIPTION>Managerial</NODE_DESCRIPTION>
        <PARENT_NODE>EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>SALES</NODE_NAME>
        <NODE_DESCRIPTION>Sales</NODE_DESCRIPTION>
        <PARENT_NODE>EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>MARKETING</NODE_NAME>
        <NODE_DESCRIPTION>Marketing</NODE_DESCRIPTION>
        <PARENT_NODE>EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>OTHER</NODE_NAME>
        <NODE_DESCRIPTION>Other</NODE_DESCRIPTION>
        <PARENT_NODE>EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>2</NODE_LEVEL>
        <NODE_NAME>NON_EXEMPT</NODE_NAME>
        <NODE_DESCRIPTION>Non Exempt / Hourly</NODE_DESCRIPTION>
        <PARENT_NODE>ALL_JOBS</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>LEVEL1</NODE_NAME>
        <NODE_DESCRIPTION>Level 1</NODE_DESCRIPTION>
        <PARENT_NODE>NON_EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>LEVEL2</NODE_NAME>
        <NODE_DESCRIPTION>Level2</NODE_DESCRIPTION>
        <PARENT_NODE>NON_EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>3</NODE_LEVEL>
        <NODE_NAME>LEVEL3</NODE_NAME>
        <NODE_DESCRIPTION>Level 3</NODE_DESCRIPTION>
        <PARENT_NODE>NON_EXEMPT</PARENT_NODE>
    </NODE>
    <NODE>
        <NODE_LEVEL>2</NODE_LEVEL>
        <NODE_NAME>CONSULTANTS</NODE_NAME>
        <NODE_DESCRIPTION>Consultants &amp; Contractors</NODE_DESCRIPTION>
        <PARENT_NODE>ALL_JOBS</PARENT_NODE>
    </NODE>
</qcs:QAS_TREE_DETAILS_RESP_MSG>