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

機械翻訳について

ケース・メッセージの更新

patch

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}

リクエスト

パス・パラメータ

CaseNumber(required): string

ケースの代替キー識別子。
MessageId(required): integer(int64)

メッセージの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

Attachments: array Attachments

タイトル: Attachments

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

タイトル: Content

添付ではないメッセージのコンテンツ。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

ケース・メッセージの企業通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

ケース・メッセージに関連付けられた通貨換算レート・タイプです。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

ケース・メッセージに関連付けられた通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
LastEditedDate: string (date-time)

タイトル: Last Update Date

ケース・メッセージが最後に編集された日付。
MessageCreatedBy: string

タイトル: Message Created By

最大長: 64

ケース・メッセージを作成したユーザー。
MessageCreationDate: string (date-time)

タイトル: Message Creation Date

ケース・メッセージが作成された日時。
MessageLastUpdateDate: string (date-time)

タイトル: Message Last Update Date

ケース・メッセージが最後に更新された日時。
MessageLastUpdatedBy: string

タイトル: Message Last Updated By

最大長: 64

ケース・メッセージを最後に更新したユーザー。
MessageLastUpdateLogin: string

タイトル: Message Last Update Login

最大長: 32

ケース・メッセージを最後に更新したユーザーのアプリケーション・ログインID。
MessageTypeCdMeaning: string

タイトル: Message Type Value

最大長: 255

ケース・メッセージのメッセージ・タイプ参照コードに対応する表示値。
ParentMessageId: integer (int64)

タイトル: Parent Message

親メッセージの一意の識別子。
PostedByPartyId: integer (int64)

タイトル: Posting Party ID

メッセージをポストしたユーザー・パーティの一意の識別子。
RichTextFlag: boolean

タイトル: Rich Text Format

最大長: 1

デフォルト値: true

メッセージ・コンテンツがリッチ・テキスト形式であるかどうかを示します。値はYまたはNです。
SourceCd: string

タイトル: Source

最大長: 30

メッセージがシステムにどのように入力されたかを示すコード。たとえば、ORA_SVC_API、REST APIを介してケース・メッセージが作成されたORA_SVC_AGENT_UI、UIでケース・メッセージが作成されたケース・メッセージ、またはモバイル・デバイスを介してケース・メッセージが作成されたORA_SVC_MOBILEなどです。
SourceCdMeaning: string

タイトル: Source Value

最大長: 255

ケース・メッセージのソース参照コードに対応する表示値。
StatusCd: string

タイトル: Status Code

最大長: 30

デフォルト値: ORA_SVC_COMMITTED

メッセージのステータスを示すコード。たとえば、ORA_SVC_COMMITTEDは、メッセージがコミットされているか、NULLであることを示します。
StatusCdMeaning: string

タイトル: Status Value

最大長: 255

ケース・メッセージのステータス参照コードに対応する表示値。
VisibilityCdMeaning: string

タイトル: Visibility Value

最大長: 255

ケース・メッセージの表示参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "PostedByPartyId":{
            "title":"Posting Party ID",
            "type":"integer",
            "description":"The unique identifier of the user party who posted the message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            }
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the message. For example,  ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.",
            "nullable":false,
            "default":"ORA_SVC_COMMITTED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            }
        },
        "MessageLastUpdateDate":{
            "title":"Message Last Update Date",
            "type":"string",
            "description":"The date and time when the case message was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "ParentMessageId":{
            "title":"Parent Message",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceCd":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the message was entered into the system. For example, ORA_SVC_API, case message was created through REST API, ORA_SVC_AGENT_UI, case message was created in the UI), or ORA_SVC_MOBILE, case message was created through a mobile device.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete an attachment.",
            "items":{
                "$ref":"#/components/schemas/cases-caseMessages-Attachments-item-patch-request"
            }
        },
        "MessageCreatedBy":{
            "title":"Message Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the case message.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "MessageTypeCdMeaning":{
            "title":"Message Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the message type lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MessageTypeCd"
                ]
            }
        },
        "MessageLastUpdatedBy":{
            "title":"Message Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the case message.",
            "nullable":true
        },
        "MessageLastUpdateLogin":{
            "title":"Message Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The application login id of the user who last updated the case message.",
            "nullable":true
        },
        "MessageCreationDate":{
            "title":"Message Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"The content of the message that is not an attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastEditedDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the case message was last edited.",
            "format":"date-time",
            "nullable":false
        },
        "SourceCdMeaning":{
            "title":"Source Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the source lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCd"
                ]
            }
        },
        "RichTextFlag":{
            "title":"Rich Text Format",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format The values are Y or N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Attachments

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

ソースを表示

Array of: object cases-caseMessages-Attachments-item-patch-request

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

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

タイプ: object

ソースを表示

CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

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

タイトル: Type

最大長: 30

デフォルト値: FILE

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

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書の一意の識別子。
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 of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the document 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"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : cases-caseMessages-item-response

タイプ: object

ソースを表示

Attachments: array Attachments

タイトル: Attachments

添付リソースは、添付の表示、作成、更新および削除に使用されます。
CaseId: integer (int64)

タイトル: Case ID

ケースの一意の識別子。
CaseNumber: string

タイトル: Case Number

最大長: 30

ケースの代替キー識別子。
コンテンツ: 文字列(バイト)

タイトル: Content

添付ではないメッセージのコンテンツ。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

ケース・メッセージの企業通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

ケースのメッセージを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

ケース・メッセージが作成された日時。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

ケース・メッセージに関連付けられた通貨換算レート・タイプです。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

ケース・メッセージに関連付けられた通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
DeleteFlag: boolean

タイトル: Delete

読取り専用: true

レコードを削除できるかどうかを示します。
LastEditedDate: string (date-time)

タイトル: Last Update Date

ケース・メッセージが最後に編集された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

ケースのメッセージが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

ケースのメッセージを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

ケースのメッセージを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Message Created By

最大長: 64

ケース・メッセージを作成したユーザー。
MessageCreationDate: string (date-time)

タイトル: Message Creation Date

ケース・メッセージが作成された日時。
MessageId: integer (int64)

タイトル: Message ID

メッセージの一意の識別子。
MessageLastUpdateDate: string (date-time)

タイトル: Message Last Update Date

ケース・メッセージが最後に更新された日時。
MessageLastUpdatedBy: string

タイトル: Message Last Updated By

最大長: 64

ケース・メッセージを最後に更新したユーザー。
MessageLastUpdateLogin: string

タイトル: Message Last Update Login

最大長: 32

ケース・メッセージを最後に更新したユーザーのアプリケーション・ログインID。
MessageNumber: string

タイトル: Message Number

最大長: 30

メッセージの代替キー識別子。
MessageTypeCd: string

タイトル: Message Type

最大長: 30

デフォルト値: ORA_SVC_NOTE

内部や外部など、メッセージのタイプを示すコード。
MessageTypeCdMeaning: string

タイトル: Message Type Value

最大長: 255

ケース・メッセージのメッセージ・タイプ参照コードに対応する表示値。
OriginationDate: string (date-time)

タイトル: Origination Date

メッセージが発生した日付またはメッセージが投稿された日付。
ParentMessageId: integer (int64)

タイトル: Parent Message

親メッセージの一意の識別子。
PostedByPartyId: integer (int64)

タイトル: Posting Party ID

メッセージをポストしたユーザー・パーティの一意の識別子。
PostedByPartyName: string

タイトル: Posted by Party Name

読取り専用: true

最大長: 360

メッセージをポストしたパーティの名前。
PostedByPartyNumber: string

タイトル: Posting Party Number

読取り専用: true

最大長: 30

メッセージをポストしたユーザー・パーティの代替キー識別子。
RichTextFlag: boolean

タイトル: Rich Text Format

最大長: 1

デフォルト値: true

メッセージ・コンテンツがリッチ・テキスト形式であるかどうかを示します。値はYまたはNです。
SourceCd: string

タイトル: Source

最大長: 30

メッセージがシステムにどのように入力されたかを示すコード。たとえば、ORA_SVC_API、REST APIを介してケース・メッセージが作成されたORA_SVC_AGENT_UI、UIでケース・メッセージが作成されたケース・メッセージ、またはモバイル・デバイスを介してケース・メッセージが作成されたORA_SVC_MOBILEなどです。
SourceCdMeaning: string

タイトル: Source Value

最大長: 255

ケース・メッセージのソース参照コードに対応する表示値。
StatusCd: string

タイトル: Status Code

最大長: 30

デフォルト値: ORA_SVC_COMMITTED

メッセージのステータスを示すコード。たとえば、ORA_SVC_COMMITTEDは、メッセージがコミットされているか、NULLであることを示します。
StatusCdMeaning: string

タイトル: Status Value

最大長: 255

ケース・メッセージのステータス参照コードに対応する表示値。
UpdateFlag: boolean

タイトル: Update

読取り専用: true

レコードを更新できるかどうかを示します。
VisibilityCd: string

タイトル: Visibility

最大長: 30

デフォルト値: ORA_SVC_INTERNAL

ケース・メッセージの表示レベルを示すコード。たとえば、ORA_SVC_EXTERNALの場合、ケース・メッセージは内部ユーザーと外部ユーザーに表示され、ORA_SVC_INTERNALの場合メッセージは内部ユーザーにのみ表示されます。
VisibilityCdMeaning: string

タイトル: Visibility Value

最大長: 255

ケース・メッセージの表示参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the message.",
            "nullable":false,
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the visibility level of the case message. For example, ORA_SVC_EXTERNAL, case message is visible to internal and external users, or ORA_SVC_INTERNAL, case message is visible to internal users only.",
            "nullable":false,
            "default":"ORA_SVC_INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the message, such as internal or external.",
            "nullable":false,
            "default":"ORA_SVC_NOTE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MessageLastUpdateDate":{
            "title":"Message Last Update Date",
            "type":"string",
            "description":"The date and time when the case message was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the message was entered into the system. For example, ORA_SVC_API, case message was created through REST API, ORA_SVC_AGENT_UI, case message was created in the UI), or ORA_SVC_MOBILE, case message was created through a mobile device.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete an attachment.",
            "items":{
                "$ref":"#/components/schemas/cases-caseMessages-Attachments-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageTypeCdMeaning":{
            "title":"Message Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the message type lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MessageTypeCd"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageLastUpdatedBy":{
            "title":"Message Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "LastEditedDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the case message was last edited.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCdMeaning":{
            "title":"Source Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the source lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCd"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the message for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedByPartyId":{
            "title":"Posting Party ID",
            "type":"integer",
            "description":"The unique identifier of the user party who posted the message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the message for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the message. For example,  ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.",
            "nullable":false,
            "default":"ORA_SVC_COMMITTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the case message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentMessageId":{
            "title":"Parent Message",
            "type":"integer",
            "description":"The unique identifier of the parent message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PostedByPartyNumber":{
            "title":"Posting Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the user party who posted the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCreatedBy":{
            "title":"Message Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageLastUpdateLogin":{
            "title":"Message Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The application login id of the user who last updated the case message.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"The date when the message originated, or was posted.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MessageCreationDate":{
            "title":"Message Creation Date",
            "type":"string",
            "description":"The date and time when the case message was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"The content of the message that is not an attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PostedByPartyName":{
            "title":"Posted by Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party who posted the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RichTextFlag":{
            "title":"Rich Text Format",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the message content is in rich text format The values are Y or N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the message for the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the message for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Attachments

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

ソースを表示

Array of: object cases-caseMessages-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete an attachment.",
    "items":{
        "$ref":"#/components/schemas/cases-caseMessages-Attachments-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"
    }
}

ネストされたスキーマ : cases-caseMessages-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

添付の作成元となる文書の一意の識別子。
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 unique identifier of the document 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 of the 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":"The 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."
        }
    }
}

リンク

添付

操作: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments

パラメータ:

CaseNumber: $request.path.CaseNumber
MessageId: $request.path.MessageId

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

MsgStatusCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_STATUS_CD

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

MsgTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_TYPE_CD

MsgVisibilityCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_VISIBILITY_CD

SourceCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_SOURCE_CD

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、ケース・メッセージを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

  {
 "CaseId": 300100215793299,
 "CorpCurrencyCode": null,
 "CreatedBy": "AUTOUICASE1",
 "CreationDate": "2021-08-23T06:29:12+00:00",
 "CurcyConvRateType": null,
 "CurrencyCode": "USD",
 "LastEditedDate": "2021-08-23T06:29:12.001+00:00",
 "LastUpdateDate": "2021-08-23T06:29:12.867+00:00",
 "LastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
 "LastUpdatedBy": "AUTOUICASE1",
 "MessageCreatedBy": "AUTOUICASE1",
 "MessageCreationDate": "2021-08-23T06:29:12+00:00",
 "MessageId": 300100215798773,
......
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "CaseId": 300100215793299,
    "CorpCurrencyCode": null,
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:12+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": "USD",
    "LastEditedDate": "2021-08-23T06:29:12.867+00:00",
    "LastUpdateDate": "2021-08-26T11:28:14.464+00:00",
    "LastUpdateLogin": "CA5FA2C68C71CFA5E05322EAF40A7B58",
    "LastUpdatedBy": "SALES_ADMIN",
    "MessageCreatedBy": "AUTOUICASE1",
    "MessageCreationDate": "2021-08-23T06:29:12+00:00",
    "MessageId": 300100215798773,
    "MessageLastUpdateDate": "2021-08-23T06:29:12.001+00:00",
    "MessageLastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
    "MessageLastUpdatedBy": "AUTOUICASE1",
    "MessageTypeCd": "ORA_SVC_NOTE",
    "OriginationDate": "2021-08-23T06:29:12+00:00",
    "ParentMessageId": null,
    "PostedByPartyId": null,
    "PostedByPartyNumber": null,
    "RichTextFlag": true,
    "SourceCd": null,
    "VisibilityCd": "ORA_SVC_INTERNAL",
    "PostedByPartyName": null,
    "CaseNumber": "CDRM_4003",
    "StatusCd": "ORA_SVC_COMMITTED",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "MessageNumber": "CDRM_4003",
    "MessageTypeCdMeaning": "Note",
    "SourceCdMeaning": null,
    "VisibilityCdMeaning": "Internal",
    "StatusCdMeaning": "Committed",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773",
            "name": "caseMessages",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773",
            "name": "caseMessages",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgStatusCdLookup",
            "name": "MsgStatusCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/SourceCdLookup",
            "name": "SourceCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgVisibilityCdLookup",
            "name": "MsgVisibilityCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgTypeCdLookup",
            "name": "MsgTypeCdLookup",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/YesNoLookup",
            "name": "YesNoLookup",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/child/Attachments",
            "name": "Attachments",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/enclosure/Content",
            "name": "Content",
            "kind": "other"
        }
    ]
}

「トップに戻る」