Delete a message design type
patch
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
Request
Path Parameters
-
MessageDesignId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
messageDesignMetadataUniqID(required): string
This is the hash key of the attributes which make up the composite key--- MessageDesignId and MessageLanguage ---for the Message Design Metadata resource and used to uniquely identify an instance of Message Design Metadata. The client should not generate the hash key value. Instead, the client should query on the Message Design Metadata collection resource with a filter on the primary key values in order to navigate to a specific instance of Message Design Metadata.
For example: messageDesignMetadata?q=MessageDesignId=<value1>;MessageLanguage=<value2>
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.
Supported Media Types
- application/json
Root 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.
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-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 : 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.