Jump to

• Request
• Response
• Examples

Update an email template

patch

/crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}

Request

Path Parameters

• TemplateNumber(required): string
  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:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• EmailBody: string (byte)
  The content of the email body.
• EmailFormat: string
  Maximum Length: 30

  The type of an email format such as HTML.
• EmailSubject: string
  Maximum Length: 2000

  The subject of an email template.
• EmailTemplateTranslations: array Email Template Translations
  Title: Email Template Translations

  The email template translations resource is used to view, create, update, and delete the email template translations.
• EmailTemplateUsages: array Email Template Usages
  Title: Email Template Usages

  Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.
• FooterTemplateNumber: string
  Maximum Length: 80

  The alternate key of an email footer template.
• TemplateActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether an email template is active or inactive.
• TemplateDescription: string
  Maximum Length: 2000

  The description of an email template.
• TemplateName: string
  Maximum Length: 240

  The name of an email template.

{
    "type":"object",
    "properties":{
        "TemplateActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an email template is active or inactive.",
            "nullable":false,
            "default":true
        },
        "EmailTemplateTranslations":{
            "title":"Email Template Translations",
            "type":"array",
            "description":"The email template translations resource is used to view, create, update, and delete the email template translations.",
            "items":{
                "$ref":"#/components/schemas/emailTemplates-EmailTemplateTranslations-item-patch-request"
            }
        },
        "EmailBody":{
            "type":"string",
            "description":"The content of the email body.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EmailTemplateUsages":{
            "title":"Email Template Usages",
            "type":"array",
            "description":"Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.",
            "items":{
                "$ref":"#/components/schemas/emailTemplates-EmailTemplateUsages-item-patch-request"
            }
        },
        "FooterTemplateNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The alternate key of an email footer template.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailSubject":{
            "maxLength":"2000",
            "type":"string",
            "description":"The subject of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "TemplateName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of an email template.",
            "nullable":false
        },
        "TemplateDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"The description of an email template.",
            "nullable":true
        },
        "EmailFormat":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of an email format such as HTML.",
            "nullable":false,
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/emailTemplates-Attachments-item-patch-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object emailTemplates-Attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/emailTemplates-Attachments-item-patch-request"
    }
}

Nested Schema : Email Template Translations

Type: array

Title: Email Template Translations

The email template translations resource is used to view, create, update, and delete the email template translations.

Show Source

• Array of: object schema

{
    "title":"Email Template Translations",
    "type":"array",
    "description":"The email template translations resource is used to view, create, update, and delete the email template translations.",
    "items":{
        "$ref":"#/components/schemas/emailTemplates-EmailTemplateTranslations-item-patch-request"
    }
}

Nested Schema : Email Template Usages

Type: array

Title: Email Template Usages

Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.

Show Source

• Array of: object emailTemplates-EmailTemplateUsages-item-patch-request

{
    "title":"Email Template Usages",
    "type":"array",
    "description":"Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.",
    "items":{
        "$ref":"#/components/schemas/emailTemplates-EmailTemplateUsages-item-patch-request"
    }
}

Nested Schema : emailTemplates-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed 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":"The title 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":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EmailBody: string (byte)
  The content of the email body.
• EmailSubject: string
  Maximum Length: 2000

  The subject of an email template.
• Language: string
  Maximum Length: 4

  The language of an email template.
• SourceLang: string
  Maximum Length: 4

  The source language of an email template.
• TemplateDescription: string
  Maximum Length: 2000

  The description of an email template.
• TemplateId: integer (int64)
  The primary key of an email template.
• TemplateName: string
  Maximum Length: 240

  The name of an email template.

{
    "type":"object",
    "properties":{
        "EmailBody":{
            "type":"string",
            "description":"The content of the email body.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"The language of an email template.",
            "nullable":false
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"The source language of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "EmailSubject":{
            "maxLength":"2000",
            "type":"string",
            "description":"The subject of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "TemplateName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "TemplateDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"The description of an email template.",
            "nullable":true,
            "x-queryable":false
        },
        "TemplateId":{
            "type":"integer",
            "description":"The primary key of an email template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : emailTemplates-EmailTemplateUsages-item-patch-request

Type: object

Show Source

• ConsumerObjectCode: string
  Maximum Length: 128

  The code of a consumer object.
• ConsumerObjectId: integer (int64)
  The identifier of a consumer object record.
• ConsumerObjectName: string
  Maximum Length: 1000

  The name of a consumer object record.
• TemplateId: integer (int64)
  The primary key of an email template.

{
    "type":"object",
    "properties":{
        "ConsumerObjectCode":{
            "maxLength":"128",
            "type":"string",
            "description":"The code of a consumer object.",
            "nullable":false
        },
        "ConsumerObjectId":{
            "type":"integer",
            "description":"The identifier of a consumer object record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConsumerObjectName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of a consumer object record.",
            "nullable":true
        },
        "TemplateId":{
            "type":"integer",
            "description":"The primary key of an email template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : emailTemplates-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the email template.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the email template was created.
• EmailBody: string (byte)
  The content of the email body.
• EmailFormat: string
  Maximum Length: 30

  The type of an email format such as HTML.
• EmailSubject: string
  Maximum Length: 2000

  The subject of an email template.
• EmailTemplateTranslations: array Email Template Translations
  Title: Email Template Translations

  The email template translations resource is used to view, create, update, and delete the email template translations.
• EmailTemplateUsages: array Email Template Usages
  Title: Email Template Usages

  Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.
• FooterTemplateNumber: string
  Maximum Length: 80

  The alternate key of an email footer template.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the email template was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the email template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Maximum Length: 128

  The object code for which an email template is created for.
• TemplateActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether an email template is active or inactive.
• TemplateDescription: string
  Maximum Length: 2000

  The description of an email template.
• TemplateId: integer (int64)
  The primary key of an email template.
• TemplateName: string
  Maximum Length: 240

  The name of an email template.
• TemplateNumber: string
  Maximum Length: 128

  The alternate key of an email template.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the email template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an email template is active or inactive.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the email template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailTemplateTranslations":{
            "title":"Email Template Translations",
            "type":"array",
            "description":"The email template translations resource is used to view, create, update, and delete the email template translations.",
            "items":{
                "$ref":"#/components/schemas/emailTemplates-EmailTemplateTranslations-item-response"
            }
        },
        "EmailTemplateUsages":{
            "title":"Email Template Usages",
            "type":"array",
            "description":"Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.",
            "items":{
                "$ref":"#/components/schemas/emailTemplates-EmailTemplateUsages-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the email template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"The description of an email template.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailFormat":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of an email format such as HTML.",
            "nullable":false,
            "x-queryable":false
        },
        "ObjectCode":{
            "maxLength":"128",
            "type":"string",
            "description":"The object code for which an email template is created for.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TemplateNumber":{
            "maxLength":"128",
            "type":"string",
            "description":"The alternate key of an email template.",
            "nullable":false,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/emailTemplates-Attachments-item-response"
            }
        },
        "EmailBody":{
            "type":"string",
            "description":"The content of the email body.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FooterTemplateNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The alternate key of an email footer template.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailSubject":{
            "maxLength":"2000",
            "type":"string",
            "description":"The subject of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "TemplateName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of an email template.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TemplateId":{
            "type":"integer",
            "description":"The primary key of an email template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the email template was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object emailTemplates-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/emailTemplates-Attachments-item-response"
    }
}

Nested Schema : Email Template Translations

Type: array

Title: Email Template Translations

The email template translations resource is used to view, create, update, and delete the email template translations.

Show Source

• Array of: object emailTemplates-EmailTemplateTranslations-item-response

{
    "title":"Email Template Translations",
    "type":"array",
    "description":"The email template translations resource is used to view, create, update, and delete the email template translations.",
    "items":{
        "$ref":"#/components/schemas/emailTemplates-EmailTemplateTranslations-item-response"
    }
}

Nested Schema : Email Template Usages

Type: array

Title: Email Template Usages

Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.

Show Source

• Array of: object emailTemplates-EmailTemplateUsages-item-response

{
    "title":"Email Template Usages",
    "type":"array",
    "description":"Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.",
    "items":{
        "$ref":"#/components/schemas/emailTemplates-EmailTemplateUsages-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 : emailTemplates-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

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI of the file.
• 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed 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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record 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
        },
        "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"
            }
        }
    }
}

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 : emailTemplates-EmailTemplateTranslations-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the email template translation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the email template translation was created.
• EmailBody: string (byte)
  The content of the email body.
• EmailSubject: string
  Maximum Length: 2000

  The subject of an email template.
• Language: string
  Maximum Length: 4

  The language of an email template.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the email template translation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the email template translation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceLang: string
  Maximum Length: 4

  The source language of an email template.
• TemplateDescription: string
  Maximum Length: 2000

  The description of an email template.
• TemplateId: integer (int64)
  The primary key of an email template.
• TemplateName: string
  Maximum Length: 240

  The name of an email template.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the email template translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the email template translation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailBody":{
            "type":"string",
            "description":"The content of the email body.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the email template translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"The language of an email template.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"The source language of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "EmailSubject":{
            "maxLength":"2000",
            "type":"string",
            "description":"The subject of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "TemplateName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of an email template.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TemplateDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"The description of an email template.",
            "nullable":true,
            "x-queryable":false
        },
        "TemplateId":{
            "type":"integer",
            "description":"The primary key of an email template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the email template translation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : emailTemplates-EmailTemplateUsages-item-response

Type: object

Show Source

• ConsumerObjectCode: string
  Maximum Length: 128

  The code of a consumer object.
• ConsumerObjectId: integer (int64)
  The identifier of a consumer object record.
• ConsumerObjectLabel: string
  Read Only: true

  Maximum Length: 255

  The label of a consumer object.
• ConsumerObjectName: string
  Maximum Length: 1000

  The name of a consumer object record.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the email template usage.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the email template usage was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the email template usage was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the email template usage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TemplateId: integer (int64)
  The primary key of an email template.
• TemplateUsageId: integer (int64)
  The primary key of an email template usage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the email template usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the email template usage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateUsageId":{
            "type":"integer",
            "description":"The primary key of an email template usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the email template usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConsumerObjectLabel":{
            "maxLength":"255",
            "type":"string",
            "description":"The label of a consumer object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumerObjectCode":{
            "maxLength":"128",
            "type":"string",
            "description":"The code of a consumer object.",
            "nullable":false,
            "x-queryable":true
        },
        "ConsumerObjectId":{
            "type":"integer",
            "description":"The identifier of a consumer object record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConsumerObjectName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of a consumer object record.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateId":{
            "type":"integer",
            "description":"The primary key of an email template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the email template usage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments

Parameters:

• TemplateNumber: $request.path.TemplateNumber

The attachments resource is used to view, create, and update attachments.

EmailTemplateTranslations

Operation: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations

Parameters:

• TemplateNumber: $request.path.TemplateNumber

The email template translations resource is used to view, create, update, and delete the email template translations.

EmailTemplateUsages

Operation: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateUsages

Parameters:

• TemplateNumber: $request.path.TemplateNumber

Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.

ObjectMetadataVO

Operation: /crmRestApi/resources/11.13.18.05/objectMetadata

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectCode; Target Attribute: ObjectCode
• Display Attribute: ObjectCode

Back to Top

Examples

The following example shows how to update an email template by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-2000 \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"TemplateName": "Opty email test in opty page 569",
"TemplateDescription": "Opty email in opty page"

}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "TemplateId": 300100570955592,
    "TemplateNumber": "MSGT-2000",
    "TemplateName": "Opty email test in opty page 569",
    "TemplateDescription": "Opty email in opty page",
    "ObjectCode": "Opportunity",
    "TemplateActiveFlag": true,
    "EmailFormat": "HTML",
    "EmailSubject": "{{$Name$}} is create on {{$OptyCreatedBy$}}",
    "CreatedBy": "MHoope",
    "CreationDate": "2023-02-15T07:34:03+00:00",
    "LastUpdatedBy": "MHoope",
    "LastUpdateDate": "2023-02-15T14:48:52.078+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-2000",
            "name": "emailTemplates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-2000",
            "name": "emailTemplates",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-2000/child/EmailTemplateTranslations",
            "name": "EmailTemplateTranslations",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/emailTemplates/MSGT-2000/enclosure/EmailBody",
            "name": "EmailBody",
            "kind": "other"
        }
    ]
}

Back to Top