Payroll Connect Payload Rule Tree Structures
payrollConnectPayloadRuleTreeStructs Based on latest (2026.09)
Create, change, delete and look up Payroll Connect Payload Rule Tree Structures. Actions include create payload rule.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
ObjectId- Required on create
- none marked
- At a glance
- 18 fields1 finders0 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRuleTreeStructs?fields=BaseName,BatchFlg,CriteriaDbiName,CriteriaSelType,CriteriaSelValue&limit=25&onlyData=true
{
"items": [
{
"BaseName": "<string, max 80>",
"BatchFlg": "<string, max 20>",
"CriteriaDbiName": "<string, max 4000>",
"CriteriaSelType": "<string, max 4000>",
"CriteriaSelValue": "<string, max 4000>"
}
],
"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 18
| Attribute | Type | Use |
|---|---|---|
BaseName | text · max 80 | Read-onlySearchable |
BatchFlg | text · max 20 | Read-onlySearchable |
CriteriaDbiName | text · max 4000 | Read-onlySearchable |
CriteriaSelType | text · max 4000 | Read-onlySearchable |
CriteriaSelValue | text · max 4000 | Read-onlySearchable |
CriteriaValueset | text · max 4000 | Read-onlySearchable |
DataType | text · max 80 | Read-onlySearchable |
DisplayFlg | text · max 4000 | Read-onlySearchable |
HideFlg | text · max 30 | Read-onlySearchable |
KeyFlg | text · max 4000 | Read-onlySearchable |
MandatoryFlg | text · max 20 | Read-onlySearchable |
Name | text · max 255 | Read-onlySearchable |
ObjectId | number | Read-onlySearchable |
ObjectType | text · max 255 | Read-onlySearchable |
ParentObjectId | number | Read-onlySearchable |
ParentObjectType | text · max 10 | Read-onlySearchable |
RequiredFlg | text · max 4000 | Read-onlySearchable |
TypeCode | text · max 30 | 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.
findByExtractDefinition·pExtractDefinitionIdpLegislativeDataGroupIdpRulePropertyIdpVendorCode
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Actions 1
POST …/action/createPayloadRule·criteriaValuesextractObjectspVendorpsourceextractdefinitionidplegislativedatagroupidprulePropertyIdpDefinitionName
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/payrollConnectPayloadRuleTreeStructsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByExtractDefinitionfor 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:BaseName, notbasename. - 18 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.