Jump to

• Request
• Response

Duplicate a message template

post

/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/action/duplicateTemplate

Duplicates a message template in the recruiting message designs collection to create a new template based on an existing one.

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

• emailType: string
  Email type associated with the message design.
• sourceMessageDesignId: number
  Source message design ID used to duplicate the template.
• templateDescription: string
  Template description for the duplicated message design.
• templateName: string
  Name of the template to be duplicated.

{
    "type":"object",
    "properties":{
        "templateName":{
            "type":"string",
            "description":"Name of the template to be duplicated.",
            "nullable":true
        },
        "emailType":{
            "type":"string",
            "description":"Email type associated with the message design.",
            "nullable":true
        },
        "templateDescription":{
            "type":"string",
            "description":"Template description for the duplicated message design.",
            "nullable":true
        },
        "sourceMessageDesignId":{
            "type":"number",
            "description":"Source message design ID used to duplicate the template.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Return value indicating the result of the duplicate template action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value indicating the result of the duplicate template action."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value indicating the result of the duplicate template action."
}

Return value indicating the result of the duplicate template action.

Back to Top