Query Access Service Operations
To enable external applications to access PeopleSoft Query, a number of service operations are available. Depending on the application, the external application will need to use several service operations in combination. The service operations for QAS are part of the service QAS_QRY_SERVICE.
QAS service operations are grouped into the following categories to help describe the service operations:
Query Creation Services (QCS)
Query Security Services (QSS)
Query Metadata Services (QMS)
Query Execution Services (QES)
Note: No processing or security is dependent on the categories; they are simply groupings for describing the service operations.
Query creation services are used by client applications to create and save a new query.
SOAP Query Creation Services
This table lists the Query Creation Services:
Service Operation Name |
Description |
---|---|
QAS_RECORDS_OPER |
Returns the list of records, along with descriptions, that are accessible to the user. |
QAS_HIERARCHY_RECORDS_OPER |
Returns the list of hierarchy records, if any, along with their descriptions. |
QAS_RELATED_RECORDS_OPER |
Returns the list of related records of all the fields in the record. |
QAS_RECORD_DEFN_OPER |
Returns the definition of a given record, including field descriptions and key information. |
QAS_TREES_OPER |
Returns the list of PeopleSoft trees that are accessible to the user. |
QAS_TREE_DETAILS_OPER |
Returns the tree details, including setID, effective date, and the list of all the nodes. |
QAS_FIELDS_OPER |
Returns the fields from all records that are accessible to the user. |
QAS_FIELD_PROPS_OPER |
Returns the properties of a given field. |
QAS_QUERY_DETAILS_OPER |
Returns the complete details of an existing query in XML format. |
QAS_SAVE_QUERY_OPER |
Validates and verifies XML-format query and saves the query in the PeopleSoft database. |
QAS_QUERY_DELETE_OPER |
Deletes the query from the PeopleSoft database. |
QAS_CREATE_CPQ_OPER |
Returns a message that contains the SQL of the Composite Query. |
RESTful Query Creation Services
This table lists the Query Creation Services:
Service Operation Name |
Description |
---|---|
QAS_RECORDS_REST_GET |
Returns the list of records, along with descriptions, that are accessible to the user. |
QAS_RECORD_DEFN_REST_GET |
Returns the definition of a given record, including field descriptions and key information. |
QAS_HIERARCHY_RECORDS_REST_GET |
Returns the list of hierarchy records, if any, along with their descriptions. |
QAS_RELATED_RECORDS_REST_GET |
Returns the list of related records of all the fields in the record. |
QAS_FIELDS_REST_GET |
Returns the fields from all records that are accessible to the user. |
QAS_FIELDS_PROPS_REST_GET |
Returns the properties of a given field. |
QAS_TREES_REST_GET |
Returns the list of PeopleSoft trees that are accessible to the user. |
QAS_TREE_DETAILS_REST_GET |
Returns the tree details, including setID, effective date, and the list of all the nodes. |
QAS_QUERY_DELETE_REST_DELETE |
Deletes the query from the PeopleSoft database. |
QAS_SAVE_QUERY_REST_POST |
Validates and verifies XML-format query and saves the query in the PeopleSoft database. |
Query security services are used to identify users and roles.
SOAP Query Security Services
This table lists the Query Security Services:
Service Operation Name |
Description |
---|---|
QAS_AUTHTOKEN_OPER |
Returns the user ID based on the PS Token passed in. |
QAS_LISTROLE_OPER |
Returns the list of roles, along with descriptions. |
QAS_LISTUSER_OPER |
Returns the list of users, along with descriptions. |
QAS_LISTROLEUSERS_OPER |
Returns the list of users for a given role, along with descriptions. |
QAS_LISTUSERROLES_OPER |
Returns the list of roles for a given user, along with descriptions. |
QAS_LOGIN_OPER |
Enables the client application to sign on to the PeopleSoft database. |
RESTful Query Security Services
This table lists the Query Security Services:
Service Operation Name |
Description |
---|---|
QAS_LISTROLE_REST_GET |
Returns the list of roles, along with descriptions. |
QAS_LISTUSER_REST_GET |
Returns the list of users, along with descriptions. |
QAS_LISTROLEUSERS_REST_GET |
Returns the list of users for a given role, along with descriptions. |
QAS_LISTUSERROLES_REST_GET |
Returns the list of roles for a given user, along with descriptions. |
Query metadata services are used to extract application data from the PeopleSoft database.
SOAP Query Metadata Services
This table lists the Query Metadata Services:
Service Operation Name |
Description |
---|---|
QAS_LISTQUERY_OPER |
Returns the list of queries, along with the query descriptions, and owner type. |
QAS_LISTQUERYPROMPTS_OPER |
Returns a list of prompts used in a specific query. |
QAS_LISTQUERYFIELDS_OPER |
Returns a list of fields for a given query. |
QAS_GETXLAT_OPER |
Returns the translate value for a given field. |
QAS_GETPROMPTTABLEVALUES_OPER |
Returns a list of field values for a given prompt. |
RESTful Query Metadata Services
This table lists the Query Metadata Services:
Service Operation Name |
Description |
---|---|
QAS_LISTQUERY_REST_GET |
Returns the list of queries, along with the query descriptions, and owner type. |
QAS_QUERY_DETAILS_REST_GET |
Returns the details of an existing query in XML format. |
QAS_LISTQUERYFIELDS_REST_GET |
Returns a list of fields for a given query. |
QAS_LISTQUERYPROMPTS_REST_GET |
Returns a list of prompts used in a specific query. |
QAS_GETPROMPTTABLEVAL_REST_GET |
Returns a list of field values for a given prompt. |
QAS_GETXLAT_REST_GET |
Returns the translate value for a given field. |
Query Execution Services are used to run the query from a third-party application.
SOAP Query Execution Services
This table lists service operations used to execute a query:
Service Operation Name |
Description |
---|---|
QAS_CANCELQUERY_OPER |
Returns the status of query cancellation. |
QAS_QUERYSTATUS_OPER |
Returns query execution status. |
QAS_EXECUTEQRYSYNC_OPER |
Returns query result. |
QAS_EXECUTEQRYASYNC_OPER |
Returns query result. |
QAS_EXECUTEQRYSYNCPOLL_OPER |
Runs the query through process scheduler and returns the query instance ID. The service operation QAS_GETQUERYRESULTS_OPER is used to retrieve the results. |
QAS_GETQUERYRESULTS_OPER |
Used to return the query results when the query is executed on the PeopleSoft database using QAS_EXECUTEQRYSYNCPOLL_OPER. |
QAS_EXECUTECPQSYNC_OPER |
Returns the composite query result in a WebRowset format. This operation is useful for end users who do not have database connection information to establish ODBC connections. |
RESTful Query Execution Services
This table lists service operations used to execute a query:
Service Operation Name |
Description |
---|---|
QAS_EXECUTEQRY_REST_GET |
Used to return the query result when the query is executed synchronously. |
QAS_EXECUTEQRY_REST_POST |
Used to return the query result in the selected format when an ad-hoc query is executed synchronously. |
QAS_EXECUTEQRYPOLL_REST_GET |
Runs the query through process scheduler and returns the query instance ID. The service operation QAS_GETQUERYRESULTS_REST_GET is used to retrieve the results. |
QAS_EXECUTEQRYPOLL_REST_POST |
Runs an ad-hoc query through process scheduler and returns the query instance ID. The service operation QAS_GETQUERYRESULTS_REST_GET is used to retrieve the results. |
QAS_GETQUERYRESULTS_REST_GET |
Used to return the query results when the query is executed on the PeopleSoft database using QAS_EXECUTEQRYPOLL_REST_GET. |
QAS_CANCELQUERY_REST_GET |
Returns the status of query cancellation. |
QAS_QUERYSTATUS_REST_GET |
Returns query execution status. |