AI Prompts
hcmPrompts Based on latest (2026.09)
Create, change, delete and look up AI Prompts. Actions include fetch bo hierarchy.
The record key hcmPromptsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
hcmPromptsUniqID- Required on create
- none marked
- At a glance
- 22 fields0 finders0 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/hcmPrompts?fields=AvailableTokens,BoHierarchyClasspath,Configurable,Description,EnabledFlag&limit=25&onlyData=true
{
"items": [
{
"AvailableTokens": "<string, max 2000>",
"BoHierarchyClasspath": "<string, max 200>",
"Configurable": "<string, max 1>",
"Description": "<string, max 4000>",
"EnabledFlag": false
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 22
| Attribute | Type | Use |
|---|---|---|
AvailableTokens | text · max 2000 | Read-onlySearchable |
BoHierarchyClasspath | text · max 200 | Read-onlySearchable |
Configurable | text · max 1 | Read-onlySearchable |
Description | text · max 4000 | Read-onlySearchable |
EnabledFlag | yes/no · max 1 | Read-onlySearchable |
ExtraProperties | text · max 4000 | Read-onlySearchable |
Family | text · max 80 | Read-onlySearchable |
Label | text · max 200 | Read-onlySearchable |
LanguageOptIn | text · max 4000 | Read-onlySearchable |
ModelCode | text · max 255 | Read-onlySearchable |
ModelProvider | text · max 80 | Read-onlySearchable |
ModelVersion | text · max 80 | Read-onlySearchable |
ModuleId | text · max 32 | Read-onlySearchable |
ObjectVersionNumber | number | Read-onlySearchable |
PersistData | text · max 1 | Read-onlySearchable |
Product | text · max 100 | Read-onlySearchable |
Prompt | text · max 2000 | Read-onlySearchable |
PromptCode | text · max 100 | Read-onlySearchable |
PromptTmpl | text | Read-only |
PromptTmplAiId | text · max 32 | Read-onlySearchable |
PromptTmplVersion | number | Read-onlySearchable |
UsecaseId | text · max 100 | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Actions 1
POST …/{hcmPromptsUniqID}/action/fetchBoHierarchy
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/hcmPromptsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AvailableTokens, notavailabletokens. - 22 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.