Jump to

• Request
• Response

Get template

post

/hcmRestApi/resources/11.13.18.05/totalCompensationPrintableStatementTemplates/action/getPrintableStatementTemplateURL

Gets the printable statement template.

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

• hostName: string
  Name of the host for the printable statement templates.
• mode: string
  Mode element for opening printable statement templates.
• templateFile: string
  File names of the printable statement templates.

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"Mode element for opening printable statement templates.",
            "nullable":true
        },
        "hostName":{
            "type":"string",
            "description":"Name of the host for the printable statement templates.",
            "nullable":true
        },
        "templateFile":{
            "type":"string",
            "description":"File names of the printable statement templates.",
            "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): string
  Response for the search values of printable statement templates.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Response for the search values of printable statement templates."
        }
    },
    "additionalProperties":false
}

Back to Top