Jump to

• Request
• Response

Create payload rule

post

/hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRuleTreeStructs/action/createPayloadRule

Creates a payload rule for the selected extract definition and returns the generated payload rule tree structure.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• criteriaValues: object criteriaValues
  Additional Properties Allowed: additionalProperties

  Criteria values used to create the payload rule.
• extractObjects: object extractObjects
  Additional Properties Allowed: additionalProperties

  Extract objects to include in the payload rule.
• pDefinitionName: string
  Payload rule definition name.
• plegislativedatagroupid: number
  Legislative data group identifier.
• prulePropertyId: number
  Rule property identifier.
• psourceextractdefinitionid: number
  Source extract definition identifier.
• pVendor: string
  Consumer code

{
    "type":"object",
    "properties":{
        "criteriaValues":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Criteria values used to create the payload rule.",
            "nullable":true
        },
        "extractObjects":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Extract objects to include in the payload rule.",
            "nullable":true
        },
        "pVendor":{
            "type":"string",
            "description":"Consumer code",
            "nullable":true
        },
        "psourceextractdefinitionid":{
            "type":"number",
            "description":"Source extract definition identifier.",
            "nullable":true
        },
        "plegislativedatagroupid":{
            "type":"number",
            "description":"Legislative data group identifier.",
            "nullable":true
        },
        "prulePropertyId":{
            "type":"number",
            "description":"Rule property identifier.",
            "nullable":true
        },
        "pDefinitionName":{
            "type":"string",
            "description":"Payload rule definition name.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : criteriaValues

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Criteria values used to create the payload rule.",
    "nullable":true
}

Criteria values used to create the payload rule.

Nested Schema : extractObjects

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Extract objects to include in the payload rule.",
    "nullable":true
}

Extract objects to include in the payload rule.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): number
  Generated payload rule tree structure returned by the action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"number",
            "description":"Generated payload rule tree structure returned by the action."
        }
    },
    "additionalProperties":false
}

Back to Top