Update a message design
post
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns
Request
Header Parameters
-
Metadata-Context:
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DesignEditorTypeCode: string
Maximum Length:
30
Default Value:ORA_ADVANCED
Editor type used for creating a message template. -
DesignName(required): string
Maximum Length:
240
Name of the Message Design. -
DesignStatusCode: string
Maximum Length:
30
Code for the design status for each message design. -
DesignTypeCode(required): string
Maximum Length:
30
Code assigned to the design type for message designs. -
MessageDesignCode(required): string
Maximum Length:
32
Message design code. -
MessageDesignId: integer
(int64)
Unique code for message designs.
-
messageDesignMetadata: array
Message Design Metadata
Title:
Message Design Metadata
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data. -
messageDesignTypes: array
Message DesignTypes
Title:
Message DesignTypes
The resource messageDesignTypes is to get different types of message designs. -
ModuleId: string
Maximum Length:
32
Module ID for the message designs. -
TemplateDescription: string
Maximum Length:
240
Description of the template.
Nested Schema : Message Design Metadata
Type:
array
Title:
Message Design Metadata
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.
Show Source
Nested Schema : Message DesignTypes
Type:
array
Title:
Message DesignTypes
The resource messageDesignTypes is to get different types of message designs.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
DefaultLanguageFlag: boolean
Maximum Length:
1
DefaultLanguageFlag for the message design metadata. -
Description: string
(byte)
Description of the message design metadata.
-
DesignMetadata: string
(byte)
DesignMetadata for the message design metadata.
-
HTMLTemplate: string
(byte)
Html Template for the message design metadata.
-
ImageURL: string
Maximum Length:
1000
Message design image link. -
MessageDesignId: integer
(int64)
MessageDesignId for each message design metadata.
-
MessageLanguage: string
Maximum Length:
4
MessageLanguage for each message design metadata. -
Subject: string
Maximum Length:
1000
Subject for each message design metadata.
Nested Schema : recruitingMessageDesigns-messageDesignTypes-item-post-request
Type:
Show Source
object
-
TypeCode: string
Maximum Length:
30
TypeCode for the message design types.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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:
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.
Root Schema : recruitingMessageDesigns-item-response
Type:
Show Source
object
-
DesignEditorTypeCode: string
Maximum Length:
30
Default Value:ORA_ADVANCED
Editor type used for creating a message template. -
DesignName: string
Maximum Length:
240
Name of the Message Design. -
DesignStatusCode: string
Maximum Length:
30
Code for the design status for each message design. -
DesignTypeCode: string
Maximum Length:
30
Code assigned to the design type for message designs. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date of last update for the message designs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDesignCode: string
Maximum Length:
32
Message design code. -
MessageDesignId: integer
(int64)
Unique code for message designs.
-
messageDesignMetadata: array
Message Design Metadata
Title:
Message Design Metadata
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data. -
messageDesignTypes: array
Message DesignTypes
Title:
Message DesignTypes
The resource messageDesignTypes is to get different types of message designs. -
ModuleId: string
Maximum Length:
32
Module ID for the message designs. -
TemplateDescription: string
Maximum Length:
240
Description of the template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Message Design Metadata
Type:
array
Title:
Message Design Metadata
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.
Show Source
Nested Schema : Message DesignTypes
Type:
array
Title:
Message DesignTypes
The resource messageDesignTypes is to get different types of message designs.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingMessageDesigns-messageDesignMetadata-item-response
Type:
Show Source
object
-
DefaultLanguageFlag: boolean
Maximum Length:
1
DefaultLanguageFlag for the message design metadata. -
Description: string
(byte)
Description of the message design metadata.
-
DescriptionString: string
Read Only:
true
Message design description string. -
DesignMetadata: string
(byte)
DesignMetadata for the message design metadata.
-
DesignMetaDataString: string
Read Only:
true
DesignMetaDataString for each message design metadata. -
HTMLTemplate: string
(byte)
Html Template for the message design metadata.
-
HTMLTemplateString: string
Read Only:
true
HTMLTemplateString for each message design metadata. -
ImageURL: string
Maximum Length:
1000
Message design image link. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDesignId: integer
(int64)
MessageDesignId for each message design metadata.
-
MessageLanguage: string
Maximum Length:
4
MessageLanguage for each message design metadata. -
Subject: string
Maximum Length:
1000
Subject for each message design metadata.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingMessageDesigns-messageDesignTypes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of each message design types. -
TypeCode: string
Maximum Length:
30
TypeCode for the message design types.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- messageDesignMetadata
-
Parameters:
- MessageDesignId:
$request.path.MessageDesignId
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data. - MessageDesignId:
- messageDesignTypes
-
Parameters:
- MessageDesignId:
$request.path.MessageDesignId
The resource messageDesignTypes is to get different types of message designs. - MessageDesignId: