Understanding REST API Endpoints for PeopleSoft Fetch By Sheet Name
This topic lists the REST resources and methods for the Fetch By Sheet Name API (exfetchbysheetname and exfetchbysheetnameexternal). Use this API to retrieve expense report by description. The Fetch By Sheet Name REST API can be used for the Expense skill.
API's that have "external" as the suffix are used by external systems. API's that do not have "external" as the suffix are used by PeopleSoft Intelligent Chat ASsistance from Oracle (PICASO) digital assistant.
This table lists the delivered API resource used with the Fetch By Sheet Name API.
|
API Resource |
Description |
|---|---|
|
API resource to retrieve expense report by description. This API is to be used with the digital assistant. |
|
|
API resource to retrieve expense report by description. This API is to be used for external consumption. |
API resource to retrieve expense report by description. This API is to be used with the digital assistant.
Method: GET
Path: /exfetchbysheetnameroot/{iSheetName}
|
Request Parameters |
Description |
|---|---|
|
iSheetName |
Expense report description. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
oSHEETAMOUNT |
Success |
Expense report amount. |
|
oSHEETCREATE |
Success |
Expense report creation date. |
|
oSHEETDESC |
Success |
Expense report description. |
|
oSHEETNAME |
Success |
Expense report name. |
|
oSHEETSTATUS |
Success |
Expense report status. |
API resource to retrieve expense report by description. This API is to be used for external consumption.
Method: GET
Path: /exfetchbysheetnamerootexternal/{iSheetName}
|
Request Parameters |
Description |
|---|---|
|
iSheetName |
Expense report description. |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
oSHEETAMOUNT |
Success |
Expense report amount. |
|
oSHEETCREATE |
Success |
Expense report creation date. |
|
oSHEETDESC |
Success |
Expense report description. |
|
oSHEETNAME |
Success |
Expense report name. |
|
oSHEETSTATUS |
Success |
Expense report status. |