Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

Eメール・テンプレートの更新

patch

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

リクエスト

パス・パラメータ

TemplateNumber(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

Attachments: array Attachments

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。
EmailBody: 文字列(バイト)

Eメール本文のコンテンツ。
EmailFormat: string

最大長: 30

HTMLなどの電子メール形式のタイプ。
EmailSubject: string

最大長: 2000

Eメール・テンプレートの件名。
EmailTemplateTranslations: array Email Template Translations

タイトル: Email Template Translations

Eメール・テンプレート翻訳リソースは、Eメール・テンプレート翻訳の表示、作成、更新および削除に使用されます。
TemplateActiveFlag: boolean

最大長: 1

デフォルト値: true

Eメール・テンプレートがアクティブか非アクティブかを示します。
TemplateDescription: string

最大長: 2000

電子メール・テンプレートの説明。
TemplateName: string

最大長: 240

Eメール・テンプレートの名前。

{
    "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
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : 添付ファイル

タイプ: array

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : 電子メール・テンプレート翻訳

タイプ: array

タイトル: Email Template Translations

Eメール・テンプレート翻訳リソースは、Eメール・テンプレート翻訳の表示、作成、更新および削除に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : emailTemplates-Attachments-item-patch-request

タイプ: object

ソースを表示

CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示す値。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書ID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付の作成元のフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の作成元となる文書バージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・コード(ある場合)。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付のファイル名。
FileUrl: string

タイトル: File Url

ファイルのURI。
Title: string

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルのサイズ。
UploadedFileName: string

タイトル: Uploaded File Name

新しい添付ファイルに割り当てる名前。
UploadedText: string

タイトル: Uploaded Text

新規テキスト添付のテキスト・コンテンツ。
Uri: string

タイトル: Uri

最大長: 4000

トポロジ・マネージャ・タイプ・アタッチメントのURI。
Url: string

タイトル: Url

最大長: 4000

webページ・タイプ添付のURL。

{
    "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"
            }
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

EmailBody: 文字列(バイト)

Eメール本文のコンテンツ。
EmailSubject: string

最大長: 2000

Eメール・テンプレートの件名。
Language: string

最大長: 4

Eメール・テンプレートの言語。
LastUpdateDate: string (date-time)

電子メール・テンプレートの翻訳が最後に更新された日付。
LastUpdatedBy: string

最大長: 64

Eメール・テンプレート翻訳を最後に更新したユーザー。
SourceLang: string

最大長: 4

Eメール・テンプレートのソース言語。
TemplateDescription: string

最大長: 2000

電子メール・テンプレートの説明。
TemplateId: integer (int64)

電子メール・テンプレートの主キー。
TemplateName: string

最大長: 240

Eメール・テンプレートの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the email template translation.",
            "nullable":false,
            "x-queryable":false
        },
        "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
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the email template translation was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : emailTemplates-item-response

タイプ: object

ソースを表示

Attachments: array Attachments

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。
CreatedBy: string

読取り専用: true

最大長: 64

電子メール・テンプレートを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

電子メール・テンプレートが作成された日時。
EmailBody: 文字列(バイト)

Eメール本文のコンテンツ。
EmailFormat: string

最大長: 30

HTMLなどの電子メール形式のタイプ。
EmailSubject: string

最大長: 2000

Eメール・テンプレートの件名。
EmailTemplateTranslations: array Email Template Translations

タイトル: Email Template Translations

Eメール・テンプレート翻訳リソースは、Eメール・テンプレート翻訳の表示、作成、更新および削除に使用されます。
LastUpdateDate: string (date-time)

読取り専用: true

Eメール・テンプレートが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

Eメール・テンプレートを最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectCode: string

最大長: 128

Eメール・テンプレートが作成されるオブジェクト・コード。
TemplateActiveFlag: boolean

最大長: 1

デフォルト値: true

Eメール・テンプレートがアクティブか非アクティブかを示します。
TemplateDescription: string

最大長: 2000

電子メール・テンプレートの説明。
TemplateId: integer (int64)

電子メール・テンプレートの主キー。
TemplateName: string

最大長: 240

Eメール・テンプレートの名前。
TemplateNumber: string

最大長: 128

Eメール・テンプレートの代替キー。

{
    "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"
            }
        },
        "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
        },
        "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
        }
    }
}

ネストされたスキーマ : 添付ファイル

タイプ: array

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : 電子メール・テンプレート翻訳

タイプ: array

タイトル: Email Template Translations

Eメール・テンプレート翻訳リソースは、Eメール・テンプレート翻訳の表示、作成、更新および削除に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : emailTemplates-Attachments-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付文書の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

レコードを作成したユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

レコードを作成したユーザーの名前。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示す値。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書ID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付の作成元のフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の作成元となる文書バージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・コード(ある場合)。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付のファイル名。
FileUrl: string

タイトル: File Url

ファイルのURI。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdatedByUserName: string

タイトル: Last Updated By User

読取り専用: true

レコードを最後に更新したユーザーの名前。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Title: string

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルのサイズ。
UploadedFileName: string

タイトル: Uploaded File Name

新しい添付ファイルに割り当てる名前。
UploadedText: string

タイトル: Uploaded Text

新規テキスト添付のテキスト・コンテンツ。
Uri: string

タイトル: Uri

最大長: 4000

トポロジ・マネージャ・タイプ・アタッチメントのURI。
Url: string

タイトル: Url

最大長: 4000

webページ・タイプ添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付を作成したユーザーのログイン資格証明。

{
    "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
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : emailTemplates-EmailTemplateTranslations-item-response

タイプ: object

ソースを表示

CreatedBy: string

最大長: 64

電子メール・テンプレート翻訳を作成したユーザー。
CreationDate: string (date-time)

電子メール・テンプレート翻訳が作成された日時。
EmailBody: 文字列(バイト)

Eメール本文のコンテンツ。
EmailSubject: string

最大長: 2000

Eメール・テンプレートの件名。
Language: string

最大長: 4

Eメール・テンプレートの言語。
LastUpdateDate: string (date-time)

電子メール・テンプレートの翻訳が最後に更新された日付。
LastUpdatedBy: string

最大長: 64

Eメール・テンプレート翻訳を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SourceLang: string

最大長: 4

Eメール・テンプレートのソース言語。
TemplateDescription: string

最大長: 2000

電子メール・テンプレートの説明。
TemplateId: integer (int64)

電子メール・テンプレートの主キー。
TemplateName: string

最大長: 240

Eメール・テンプレートの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the email template translation.",
            "nullable":false,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the email template translation was created.",
            "format":"date-time",
            "nullable":false,
            "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,
            "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,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

リンク

添付

操作: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments

パラメータ:

TemplateNumber: $request.path.TemplateNumber

添付リソースは、添付の表示、作成および更新に使用されます。

EmailTemplateTranslations

操作: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations

パラメータ:

TemplateNumber: $request.path.TemplateNumber

Eメール・テンプレート翻訳リソースは、Eメール・テンプレート翻訳の表示、作成、更新および削除に使用されます。

ObjectMetadataVO

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ObjectCode;ターゲット属性: ObjectCode
表示属性: ObjectCode

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して、電子メール・テンプレートを更新する方法を示しています。

cURLコマンド

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

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

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

}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "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"
        }
    ]
}

「トップに戻る」