Recruiting Interactions
recruitingUIInteractions Based on latest (2026.09)
Create and look up Recruiting Interactions, with interaction recipients. Actions include add interaction.
The record key recruitingUIInteractionsUniqID 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)1 action
- Record key
recruitingUIInteractionsUniqID- Required on create
- none marked
- At a glance
- 17 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions?fields=AddedByPersonId,ContextId,ContextTypeCode,DisplayName,EventName&limit=25&onlyData=true
{
"items": [
{
"AddedByPersonId": 0,
"ContextId": 0,
"ContextTypeCode": "<string, max 30>",
"DisplayName": "<string>",
"EventName": "<string>"
}
],
"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 17
| Attribute | Type | Use |
|---|---|---|
AddedByPersonId | number | Read-onlySearchable |
ContextId | number | Read-onlySearchable |
ContextTypeCode | text · max 30 | Read-onlySearchable |
DisplayName | text | Read-onlySearchable |
EventName | text | Read-onlySearchable |
EventNumber | text | Read-onlySearchable |
HiringTeamInternalFlag | yes/no · max 1 | Read-onlySearchable |
InteractionDate | text | Read-onlySearchable |
InteractionId | number | Read-onlySearchable |
InteractionTypeCode | text · max 30 | Read-onlySearchable |
InteractionTypeLabel | text | Read-onlySearchable |
InteractionView | text | Read-onlySearchable |
PersonId | number | Read-onlySearchable |
PoolName | text | Read-onlySearchable |
RequisitionNumber | text | Read-onlySearchable |
Text | text | Read-onlySearchable |
Title | text | 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·ContextIdContextTypeCodeInteractionViewPersonId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/<name>. Add them to a GET with expand.
InteractionRecipientsGET · POST Recruiting Interaction Recipients · 7 fieldsAgentIdContextTypeCodeDisplayNameInteractionIdInteractionRecipientIdInteractionViewPersonId
Actions 1
POST …/action/addInteraction·interactionDateinteractionTextinteractionTypeCodecontextIdspersonIdscontextTypeCode
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/recruitingUIInteractionsand 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.
- 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:AddedByPersonId, notaddedbypersonid. - 17 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.