Using the PTLOOKUPPROMPT_REST_GET Service Operation

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 PeopleTools, and then Integration Broker, and then Integration Setup, and then Services. 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.

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}