Jump to

• Request
• Response

Import payload rule

post

/hcmRestApi/resources/11.13.18.05/payrollConnectPayloadRules/action/importPayloadRule

Imports a payload rule using the supplied file content and returns the imported payload rule details.

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

• fileContent: string
  Imported payload rule file content.
• ldgCode: string
  Legislation code.
• ldgId: number
  Legislative data group identifier.
• newPayloadRuleName: string
  New payload rule name.

{
    "type":"object",
    "properties":{
        "ldgId":{
            "type":"number",
            "description":"Legislative data group identifier.",
            "nullable":true
        },
        "newPayloadRuleName":{
            "type":"string",
            "description":"New payload rule name.",
            "nullable":true
        },
        "ldgCode":{
            "type":"string",
            "description":"Legislation code.",
            "nullable":true
        },
        "fileContent":{
            "type":"string",
            "description":"Imported payload rule file content.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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): boolean
  Imported payload rule details returned by the action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"boolean",
            "description":"Imported payload rule details returned by the action."
        }
    },
    "additionalProperties":false
}

Back to Top