Candidate Profile Metadata
recruitingUICandidateProfileMetadata Based on latest (2026.09)
Look up Candidate Profile Metadata, with candidate actions and candidate tabs. Read-only.
- Operations
- GET (list)GET (one)
- Record key
CandidateNumber- Required on create
- no create on this resource
- At a glance
- 3 fields1 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata?fields=CandidateNumber,Context,ContextId&limit=25&onlyData=true
{
"items": [
{
"CandidateNumber": "<string>",
"Context": "<string, max 255>",
"ContextId": "<string, max 255>"
}
],
"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 3
| Attribute | Type | Use |
|---|---|---|
CandidateNumber | text | Read-onlySearchable |
Context | text · max 255 | Read-onlySearchable |
ContextId | text · max 255 | 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.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByContext·CandidateNumberContextContextId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/<name>. Add them to a GET with expand.
CandidateActionsGET Candidate Actions · 5 fieldsActionIdActionNameCandidateNumberContextContextIdCandidateTabsGET Candidate Tabs · 5 fieldsCandidateNumberContextContextIdTabIdTabName
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadataand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByContextfor the agent's main search: its variables become clean tool parameters. - 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.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CandidateNumber, notcandidatenumber. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.