ケース・メッセージの作成
post
/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages
リクエスト
パス・パラメータ
- CaseNumber(required): string
ケースの代替キー識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
Attachments: array Attachments
タイトル:
Attachments添付リソースは、添付の表示、作成、更新および削除に使用されます。 -
CaseId(required): integer (int64)
タイトル:
Case IDケースの一意の識別子。 -
CaseNumber(required): string
タイトル:
Case Number最大長:30ケースの代替キー識別子。 -
コンテンツ: 文字列(バイト)
タイトル:
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ケース・メッセージが作成された日時。 -
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メッセージをポストしたユーザー・パーティの一意の識別子。 -
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ケース・メッセージのステータス参照コードに対応する表示値。 -
VisibilityCd: string
タイトル:
Visibility最大長:30デフォルト値:ORA_SVC_INTERNALケース・メッセージの表示レベルを示すコード。 たとえば、ORA_SVC_EXTERNALの場合、ケース・メッセージは内部ユーザーと外部ユーザーに表示され、ORA_SVC_INTERNALの場合メッセージは内部ユーザーにのみ表示されます。 -
VisibilityCdMeaning: string
タイトル:
Visibility Value最大長:255ケース・メッセージの表示参照コードに対応する表示値。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Idファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category最大長:30添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
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最大長:4000webページ・タイプ添付のURL。
応答
サポートされるメディア・タイプ
- 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ケース・メッセージの表示参照コードに対応する表示値。
ネストされたスキーマ : 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
-
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最大長:4000webページ・タイプ添付のURL。 -
UserName: string
タイトル:
User Name読取り専用:true最大長:255添付を作成したユーザーのログイン資格証明。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- 添付
-
パラメータ:
- CaseNumber:
$request.path.CaseNumber - MessageId:
$request.path.MessageId
添付リソースは、添付の表示、作成および更新に使用されます。 - CaseNumber:
- MsgStatusCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_STATUS_CD
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- MsgTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_TYPE_CD
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- MsgVisibilityCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_MSG_VISIBILITY_CD
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- SourceCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_SOURCE_CD
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- YesNoLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DYES_NO
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ: