Payroll Connect Payload Rules
payrollConnectPayloadRules Based on latest (2026.09)
Create, change, delete and look up Payroll Connect Payload Rules. Actions include export payload rule and import payload rule.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
- Record key
RulePropertyId- Required on create
- none marked
- At a glance
- 17 fields1 finders0 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRules?fields=DeleteAllowedFlag,Display,ExtractDataElementId,ExtractDefinitionId,Include&limit=25&onlyData=true
{
"items": [
{
"DeleteAllowedFlag": false,
"Display": "<string, max 150>",
"ExtractDataElementId": 0,
"ExtractDefinitionId": 0,
"Include": "<string, max 150>"
}
],
"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 |
|---|---|---|
DeleteAllowedFlag | yes/no | Read-onlySearchable |
Display | text · max 150 | Optional on createUpdatableSearchable |
ExtractDataElementId | number | Optional on createSearchable |
ExtractDefinitionId | number | Optional on createSearchable |
Include | text · max 150 | Optional on createUpdatableSearchable |
IncludedBatch | text · max 20 | Optional on createUpdatableSearchable |
IncludedRealtime | text · max 20 | Optional on createUpdatableSearchable |
LegislationCode | text · max 30 | Optional on createSearchable |
LegislativeDataGroupId | number | Optional on createSearchable |
Mandatory | text · max 20 | Optional on createUpdatableSearchable |
ParentRulePropertyId | number | Optional on createSearchable |
PayloadRuleName | text · max 30 | Optional on createSearchable |
ReportBlockId | number | Optional on createSearchable |
ReportRecordId | number | Optional on createSearchable |
RulePropertyId | number | Optional on createSearchable |
SetupPayloadId | number | Optional on createUpdatableSearchable |
SourceDefinitionType | 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.
findByName·pPayloadRuleName
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Actions 2
POST …/action/exportPayloadRule·exportPayloadRuleIdexportPayloadRuleNamePOST …/action/importPayloadRule·ldgIdnewPayloadRuleNameldgCodefileContent
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/payrollConnectPayloadRulesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByNamefor 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:Display, notdisplay. - 2 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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.