Understanding REST API Endpoints for PeopleSoft Chatbot Integration Framework Utility Services (utilities)

This topic lists the REST resources and its methods for the Chatbot Integration Framework Utility Services API (utilities). Use this API to retrieve message catalog and user profile details. You can also verify access for particular end point of REST service for a user.

This table lists the delivered API resources used with the Chatbot Integration Framework Utility Services API.

API Resource

Description

messagecatalog

API resource to retrieve message catalog data for a given set number and message number.

serviceaccess

API resource to verify access for service given the component name.

user

API resource to retrieve user profile details.

API resource to retrieve message catalog data for a given set number and message number.

Method: GET

Path: /message/{msgSetNumber}

Request Parameters

Description

msgSetNumber

Message set number.

Response Parameters

Response Result Type

Description

 
"msgCatBundleObject": {
    "msgCatBundleObject": {
      "msgSetNumber": {
        "messageNumber":

Success

Message Number and Text in a Message Set.

 
"msgCatDescrBundleObject": {
      "msgSetNumber": {
        "messageNumber":

Success

Message Number and Description in a Message Set.

Method: POST

Path: /message/{msgSetNumber}

Request Parameters

Description

msgSetNumber

Message set number.

Response Parameters

Response Result Type

Description

 
"msgCatBundleObject": {
    "msgCatBundleObject": {
      "msgSetNumber": {
        "messageNumber":

Success

Message Number and Text in a Message Set.

 
 "msgCatDescrBundleObject": {
      "msgSetNumber": {
        "messageNumber"

Success

Message Number and Description in a Message Set.

API resource to verify access for service given the component name.

Method: GET

Path: /verify/{componentName}

Request Parameters

Description

componentname

ODA component name.

Response Parameters

Response Result Type

Description

No response parameters.

N/A

N/A

Response Result Code

Description

200

Authorized

Unauthorized

Invalid

Method: GET

Path: /verify/{serviceID}/{root}/{uri}/{method}

Request Parameters

Description

serviceID

Service ID.

root

Root resource name.

uri

URI template ID.

method

API method.

Response Parameters

Response Result Type

Description

No response parameters

N/A

N/A

Response Result Code

Description

200

Authorized

Unauthorized

Invalid

API resource to retrieve user profile details.

Method: GET

Path: /profile

Request Parameters

Description

None available.

N/A

Response Parameters

Response Result Type

Description

emailAddress

Success

Email address.

employeeID

Success

Employee ID.

language

Success

Language.

languageBase

Success

Base language.

languageUser

Success

User language.

operatorDescr

Success

Operator description.

operatorID

Success

Operator ID.