Jump to

• Request
• Response

Delete a message design metadata

patch

/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}

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=

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attachments: array Communicate Attachments
  Title: Communicate Attachments

  The attachments resource is a child of messageDesigns. It includes the details of attachments.
• 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.
• MessageDesignCode: string
  Maximum Length: 32

  Message design code.
• 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.

{
    "type":"object",
    "properties":{
        "DesignEditorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Editor type used for creating a message template.",
            "nullable":true,
            "default":"ORA_ADVANCED"
        },
        "DesignName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the Message Design.",
            "nullable":false
        },
        "DesignStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the design status for each message design.",
            "nullable":true
        },
        "DesignTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code assigned to the design type for message designs.",
            "nullable":false
        },
        "MessageDesignCode":{
            "maxLength":32,
            "type":"string",
            "description":"Message design code.",
            "nullable":false
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Module ID for the message designs.",
            "nullable":true
        },
        "TemplateDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the template.",
            "nullable":true
        },
        "attachments":{
            "title":"Communicate Attachments",
            "type":"array",
            "description":"The attachments resource is a child of messageDesigns. It includes the details of attachments.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-attachments-item-patch-request"
            }
        },
        "messageDesignMetadata":{
            "title":"Message Design Metadata",
            "type":"array",
            "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-patch-request"
            }
        },
        "messageDesignTypes":{
            "title":"Message DesignTypes",
            "type":"array",
            "description":"The resource messageDesignTypes is to get different types of message designs.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-patch-request"
            }
        }
    }
}

Nested Schema : Communicate Attachments

Type: array

Title: Communicate Attachments

The attachments resource is a child of messageDesigns. It includes the details of attachments.

Show Source

• Array of: object recruitingMessageDesigns-attachments-item-patch-request

{
    "title":"Communicate Attachments",
    "type":"array",
    "description":"The attachments resource is a child of messageDesigns. It includes the details of attachments.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-attachments-item-patch-request"
    }
}

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

• Array of: object recruitingMessageDesigns-messageDesignMetadata-item-patch-request

{
    "title":"Message Design Metadata",
    "type":"array",
    "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-patch-request"
    }
}

Nested Schema : Message DesignTypes

Type: array

Title: Message DesignTypes

The resource messageDesignTypes is to get different types of message designs.

Show Source

• Array of: object recruitingMessageDesigns-messageDesignTypes-item-patch-request

{
    "title":"Message DesignTypes",
    "type":"array",
    "description":"The resource messageDesignTypes is to get different types of message designs.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-patch-request"
    }
}

Nested Schema : recruitingMessageDesigns-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates where the attachment is shared. If True, the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date and time of the attachment content.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that the user can perform after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that the user can perform after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"File content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : recruitingMessageDesigns-messageDesignMetadata-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DefaultLanguageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"DefaultLanguageFlag for the message design metadata.",
            "nullable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DesignMetadata":{
            "type":"string",
            "description":"DesignMetadata for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "HTMLTemplate":{
            "type":"string",
            "description":"Html Template for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Message design image link.",
            "nullable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"MessageDesignId for each message design metadata.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MessageLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"MessageLanguage for each message design metadata.",
            "nullable":false
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"Subject for each message design metadata.",
            "nullable":true
        }
    }
}

Nested Schema : recruitingMessageDesigns-messageDesignTypes-item-patch-request

Type: object

Show Source

• TypeCode: string
  Maximum Length: 30

  TypeCode for the message design types.

{
    "type":"object",
    "properties":{
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"TypeCode for the message design types.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : recruitingMessageDesigns-item-response

Type: object

Show Source

• attachments: array Communicate Attachments
  Title: Communicate Attachments

  The attachments resource is a child of messageDesigns. It includes the details of attachments.
• CreatedByName: string
  Read Only: true

  Maximum Length: 255

  Name of the user who created the message template.
• 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.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who created the message template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DesignEditorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Editor type used for creating a message template.",
            "nullable":true,
            "default":"ORA_ADVANCED",
            "x-queryable":true
        },
        "DesignName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the Message Design.",
            "nullable":false,
            "x-queryable":true
        },
        "DesignStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the design status for each message design.",
            "nullable":true,
            "x-queryable":true
        },
        "DesignTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code assigned to the design type for message designs.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date of last update for the message designs.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MessageDesignCode":{
            "maxLength":32,
            "type":"string",
            "description":"Message design code.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"Unique code for message designs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Module ID for the message designs.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the template.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Communicate Attachments",
            "type":"array",
            "description":"The attachments resource is a child of messageDesigns. It includes the details of attachments.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "messageDesignMetadata":{
            "title":"Message Design Metadata",
            "type":"array",
            "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-response"
            }
        },
        "messageDesignTypes":{
            "title":"Message DesignTypes",
            "type":"array",
            "description":"The resource messageDesignTypes is to get different types of message designs.",
            "items":{
                "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-response"
            }
        }
    }
}

Nested Schema : Communicate Attachments

Type: array

Title: Communicate Attachments

The attachments resource is a child of messageDesigns. It includes the details of attachments.

Show Source

• Array of: object recruitingMessageDesigns-attachments-item-response

{
    "title":"Communicate Attachments",
    "type":"array",
    "description":"The attachments resource is a child of messageDesigns. It includes the details of attachments.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object recruitingMessageDesigns-messageDesignMetadata-item-response

{
    "title":"Message Design Metadata",
    "type":"array",
    "description":"The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignMetadata-item-response"
    }
}

Nested Schema : Message DesignTypes

Type: array

Title: Message DesignTypes

The resource messageDesignTypes is to get different types of message designs.

Show Source

• Array of: object recruitingMessageDesigns-messageDesignTypes-item-response

{
    "title":"Message DesignTypes",
    "type":"array",
    "description":"The resource messageDesignTypes is to get different types of message designs.",
    "items":{
        "$ref":"#/components/schemas/recruitingMessageDesigns-messageDesignTypes-item-response"
    }
}

Nested Schema : recruitingMessageDesigns-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attachment. Application generated primary key.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates where the attachment is shared. If True, the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Name of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates data type code of attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Attachment document preview URL.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date and time of the attachment content.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the user who last updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that the user can perform after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• TrackerId: string
  Read Only: true

  Maximum Length: 255

  Tracker ID of the uploaded file.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  File content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  File length of the attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  File name of the attachment.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name associated with the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attachment. Application generated primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Attachment document preview URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that the user can perform after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "TrackerId":{
            "maxLength":255,
            "type":"string",
            "description":"Tracker ID of the uploaded file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"File content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingMessageDesigns-messageDesignMetadata-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DefaultLanguageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"DefaultLanguageFlag for the message design metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DescriptionString":{
            "type":"string",
            "description":"Message design description string.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Description"
                ]
            },
            "x-queryable":true
        },
        "DesignMetaDataString":{
            "type":"string",
            "description":"DesignMetaDataString for each message design metadata.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DesignMetadata"
                ]
            },
            "x-queryable":true
        },
        "DesignMetadata":{
            "type":"string",
            "description":"DesignMetadata for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "HTMLTemplate":{
            "type":"string",
            "description":"Html Template for the message design metadata.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "HTMLTemplateString":{
            "type":"string",
            "description":"HTMLTemplateString for each message design metadata.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "HTMLTemplate"
                ]
            },
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Message design image link.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"MessageDesignId for each message design metadata.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"MessageLanguage for each message design metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"Subject for each message design metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingMessageDesigns-messageDesignTypes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of each message design types.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"TypeCode for the message design types.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

attachments

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/attachments

Parameters:

• MessageDesignId: $request.path.MessageDesignId

The attachments resource is a child of messageDesigns. It includes the details of attachments.

messageDesignMetadata

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/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.

messageDesignTypes

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes

Parameters:

• MessageDesignId: $request.path.MessageDesignId

The resource messageDesignTypes is to get different types of message designs.

Back to Top