Requisition Agents
recruitingUIRequisitionAgents Based on latest (2026.09)
Create, change, delete and look up Requisition Agents, with agent job families and agent locations.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
RequisitionId- Required on create
Action- At a glance
- 14 fields1 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents?fields=Action,AgencyId,AgencyName,AgentId,AgentName&limit=25&onlyData=true
{
"items": [
{
"Action": "<string, max 255>",
"AgencyId": 0,
"AgencyName": "<string, max 255>",
"AgentId": 0,
"AgentName": "<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 14
| Attribute | Type | Use |
|---|---|---|
Action | text · max 255 | Required on createUpdatableSearchable |
AgencyId | number | Optional on createUpdatableSearchable |
AgencyName | text · max 255 | Optional on createUpdatableSearchable |
AgentId | number | Optional on createUpdatableSearchable |
AgentName | text · max 255 | Optional on createUpdatableSearchable |
ExpirationDate | date-time | Optional on createUpdatableSearchable |
ExpirationStatus | text · max 255 | Optional on createUpdatableSearchable |
GeographyName | text · max 255 | Optional on createUpdatableSearchable |
IsInvited | text · max 255 | Optional on createUpdatableSearchable |
JobFamilyName | text · max 255 | Optional on createUpdatableSearchable |
PublishEndDate | date-time | Optional on createUpdatableSearchable |
RequisitionId | number | Optional on createUpdatableSearchable |
SuccessfulSubmissionPercent | number | Optional on createUpdatableSearchable |
TimeZone | text · max 255 | Optional on createUpdatableSearchable |
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.
findByRequisitionId·RequisitionId
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/recruitingUIRequisitionAgents/{RequisitionId}/child/<name>. Add them to a GET with expand.
agentJobFamiliesGET Agent Job Families · 8 fieldsJobFamilyIdJobFamilyNameObjectCxtIdObjectCxtJobFamIdObjectIdObjectTypeCodeObjectVersionNumberObjectVersionNumberFamilyagentLocationsGET Agent Locations · 8 fieldsGeographyIdGeographyNameObjectCxtIdObjectCxtLocIdObjectIdObjectTypeCodeObjectVersionNumberObjectVersionNumberLocation
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByRequisitionIdfor 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:Action, notaction. - Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.