Jump to

• Request
• Response

Create a message template

post

/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/action/createTemplate

Creates a message template for recruiting purposes, enabling users to design and save custom message formats for candidate communication.

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

• copyFromTemplateId: number
  Identifier of the template to copy from when creating a new message design.
• designEditorTypeCode: string
  Type of editor used for designing the message template.
• templateDescription: string
  Template description for the recruiting message design.
• templateDesignCode: string
  Unique code for the message template design.
• templateName: string
  Name of the template to be created for the recruiting message design.
• templateType: string
  Template type for the message design. Valid values are defined in the associated list of values.
• types: array types
  Types of message templates available for creation.

{
    "type":"object",
    "properties":{
        "templateType":{
            "type":"string",
            "description":"Template type for the message design. Valid values are defined in the associated list of values.",
            "nullable":true
        },
        "types":{
            "type":"array",
            "description":"Types of message templates available for creation.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "templateDesignCode":{
            "type":"string",
            "description":"Unique code for the message template design.",
            "nullable":true
        },
        "templateName":{
            "type":"string",
            "description":"Name of the template to be created for the recruiting message design.",
            "nullable":true
        },
        "designEditorTypeCode":{
            "type":"string",
            "description":"Type of editor used for designing the message template.",
            "nullable":true
        },
        "templateDescription":{
            "type":"string",
            "description":"Template description for the recruiting message design.",
            "nullable":true
        },
        "copyFromTemplateId":{
            "type":"number",
            "description":"Identifier of the template to copy from when creating a new message design.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : types

Type: array

Types of message templates available for creation.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Types of message templates available for creation.",
    "nullable":true,
    "items":{
        "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): object result
  Additional Properties Allowed: additionalProperties

  Return value after creating a message template.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value after creating a message template."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value after creating a message template."
}

Return value after creating a message template.

Back to Top