ケース・メッセージの作成
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
最大長:4000
webページ・タイプ添付の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
最大長:4000
webページ・タイプ添付の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
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ: