Delete a message design metadata
patch
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/attachments/{attachmentsUniqID}
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=
-
attachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Recruiting Campaign Email Designs resource and used to uniquely identify an instance of Recruiting Campaign Email Designs. The client should not generate the hash key value. Instead, the client should query on the Recruiting Campaign Email Designs collection resource in order to navigate to a specific instance of Recruiting Campaign Email Designs to get the hash key.
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
-
CategoryName: string
Title:
Category
Maximum Length:30
Description of the template. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Description of the template. -
Description: string
Title:
Description
Maximum Length:255
Description of the template. -
DmDocumentId: string
Maximum Length:
255
Description of the template. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Description of the template. -
DmVersionNumber: string
Maximum Length:
255
Description of the template. -
DownloadInfo: string
Title:
DownloadInfo
Description of the template. -
ErrorStatusCode: string
Title:
Error Status Code
Description of the template. -
ErrorStatusMessage: string
Title:
Error Status Message
Description of the template. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Description of the template. -
FileContents: string
(byte)
Title:
File Contents
Description of the template. -
FileName: string
Title:
File Name
Maximum Length:2048
Description of the template. -
FileUrl: string
Title:
File Url
Description of the template. -
PostProcessingAction: string
Title:
PostProcessingAction
Description of the template. -
Title: string
Title:
Title
Description of the template. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Description of the template. -
UploadedFileLength: integer
Title:
File Size
Description of the template. -
UploadedFileName: string
Title:
Uploaded File Name
Description of the template. -
UploadedText: string
Title:
Uploaded Text
Description of the template. -
Uri: string
Title:
Uri
Maximum Length:4000
Description of the template. -
Url: string
Title:
Url
Maximum Length:4000
Description of the template.
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-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Description of the template. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Description of the template. -
CategoryName: string
Title:
Category
Maximum Length:30
Description of the template. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Description of the template. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Description of the template. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Description of the template. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Description of the template. -
Description: string
Title:
Description
Maximum Length:255
Description of the template. -
DmDocumentId: string
Maximum Length:
255
Description of the template. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Description of the template. -
DmVersionNumber: string
Maximum Length:
255
Description of the template. -
DocumentPreviewURL: string
Read Only:
true
Maximum Length:255
Description of the template. -
DownloadInfo: string
Title:
DownloadInfo
Description of the template. -
ErrorStatusCode: string
Title:
Error Status Code
Description of the template. -
ErrorStatusMessage: string
Title:
Error Status Message
Description of the template. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Description of the template. -
FileContents: string
(byte)
Title:
File Contents
Description of the template. -
FileName: string
Title:
File Name
Maximum Length:2048
Description of the template. -
FileUrl: string
Title:
File Url
Description of the template. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Description of the template. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Description of the template. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Description of the template. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Description of the template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Description of the template. -
Title: string
Title:
Title
Description of the template. -
TrackerId: string
Read Only:
true
Maximum Length:255
Description of the template. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Description of the template. -
UploadedFileLength: integer
Title:
File Size
Description of the template. -
UploadedFileName: string
Title:
Uploaded File Name
Description of the template. -
UploadedText: string
Title:
Uploaded Text
Description of the template. -
Uri: string
Title:
Uri
Maximum Length:4000
Description of the template. -
Url: string
Title:
Url
Maximum Length:4000
Description of the template. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Description of the template.
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.