Validating Prompt Table Field Values
This section discusses how to use the PTLOOKUPPROMPT service operation and the PTLOOKUPPROMPT_REST_GET service operation to validate prompt table field values.
Use service operation security permission lists to secure access to these service operations.
Requests must be sent to the PeopleSoft system using SSL or TLS.
Moreover, because prompt table field values can contain sensitive or confidential information, such as salary grades or order categories. Access to the prompt tables targeted by the PTLOOKUPPROMPT service operation and the PTLOOKUPPROMPT_REST_GET service operation are restricted by the requirement that they be added to a query access tree for which the user issuing the service request must be granted permission.
The PTLOOKUPPROMPT service operation is a non-REST-based service operation that you can use to validate prompt table field values. To access the service operation, select and select the PTLOOKUPPROMPT service operation.
PTLOOKUPPROMPT is a restricted service operation that is delivered with the following metadata:
|
Metadata Type |
Name |
Description |
|---|---|---|
|
Request Message |
PTLOOKUPPROMPT.V1 |
PTLOOKUPPROMPT.V1 is a document-based message. |
|
Response Message |
PTLOOKUPRESP.V1 |
PTLOOKUPRESP.V1 is a document-based message. |
|
Handler |
REQUESTHNDLR |
REQUESTHNDLR is an OnRequest handler that is implemented using an application class. The application class package delivered is PT_IB_LOOKUP and the class ID is RequestHandler. |
|
Routing |
System generated. |
PeopleSoft delivers a system-generated synchronous any-to-local routing for this service operation. |
|
Listening Connector |
PeopleSoftServices |
The default listening connector. |
The PTLOOKUPPROMPT_REST_GET is a REST-based service operation that you can use to validate prompt table field values. To access the service operation, select Select the PTLOOKUP_REST service. The Services page appears. In the Existing Operations section click PTLOOKUPPROMPT_REST_GET.
The PTLOOKUPPROMPT_REST_GET service operation is delivered with the following metadata:
|
Metadata Type |
Name |
Description |
|---|---|---|
|
URI Templates |
NA |
The service operation is delivered with six (6) pre-defined URI templates. The templates are listed after this table. |
|
Document Template |
PTLOOKUPPROMPTTMPL.V1 |
The Document type message. The document message has elements defined with names used for value replacement within the URI template(s). |
|
Request Message |
NA |
In a REST-based service operation a request is made by sending a URL based on one of the URI templates. |
|
Response Message |
PTLOOKUPRESP.V1 |
PTLOOKUPRESP.V1 is a document-based message. |
|
Fault Message |
PT_LOOKUP_RESTFAULT.v1 |
PT_LOOKUP_RESTFAULT.v1 is a document-based message. |
|
Handler |
REQUESTHNDLR |
REQUESTHNDLR is an OnRequest handler that is implemented using an application class. The application class package delivered is PT_IB_LOOKUP and the class ID is RequestHandler.I |
|
Routing |
System generated. |
PeopleSoft delivers a system-generated synchronous any-to-local routing for this service operation. |
|
Listening Connector |
RESTListeningConnector |
The default listening connector. |
The following URI templates are delivered with this service operation:
Lookup/{LookupRecName}/{LookupFieldName}?fieldvalue={LookupFieldValue}Lookup/{LookupRecName}/{SetIDValue}/{LookupFieldName}?fieldvalue={LookupFieldValue}Lookup/{LookupRecName}/{LanguageCode}/{SetIDValue}/{LookupFieldName}?fieldvalue={LookupFieldValue}Lookup/{LookupRecName}/{EffectiveDate}/{LanguageCode}/{SetIDValue}/{LookupFieldName}?fieldvalue={LookupFieldValue}Lookup/{LookupRecName}/{EffectiveDate}/{LanguageCode}/{SetIDValue}/{DescrFieldName }/{LookupFieldName}?fieldvalue={LookupFieldValue}Lookup/{LookupRecName}/{EffectiveDate}/{LanguageCode}/{SetIDValue}/{SetControlFieldValue}/{DescrFieldName }/{LookupFieldName}?fieldvalue={LookupFieldValue}