すべてのメッセージを取得
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages
リクエスト
パス・パラメータ
- SrNumber(required): string
サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : メッセージIDを使用してサービス・リクエスト・メッセージを検索します。
ファインダ変数:- MessageId; integer; ファインダ・サービスにパラメータとして渡されるサービス・リクエスト・メッセージID。
- PrimaryKey : メッセージIDを使用してサービス・リクエスト・メッセージを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ChannelTypeCd; string; チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
- CreatedBy; string; メッセージを作成したユーザー。
- CreatedByEmailAddress; string; サービス・リクエスト・メッセージを作成したユーザーの電子メール・アドレス。
- CreatedByPartyId; string; サービス・リクエスト・メッセージを作成したユーザーの一意の識別子。
- CreationDate; string; メッセージが作成された日時。
- LastUpdateDate; string; メッセージが最後に更新された日時。
- LastUpdateLogin; string; メッセージを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; メッセージを最後に更新したユーザー。
- MessageCreatedBy; string;元のソース・システムでメッセージを作成したユーザー。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。
- MessageExpandingState; integer; メッセージ拡張状態を示します。
- MessageId; integer; サービス・リクエスト・メッセージの一意の識別子。
- MessageLastUpdateDate; string;元のソース・システムにおけるメッセージの最終更新日。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。
- MessageLastUpdateLogin; string;元のソース・システムでメッセージを最後に更新したユーザーのログイン。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。
- MessageLastUpdatedBy; string;元のソース・システムでメッセージを最後に更新したユーザー。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。
- MessageNumber; string; サービス・リクエスト・メッセージの公開一意識別子。
- MessageSubTypeCd; string;サービス・リクエスト・メッセージ・サブタイプ。
- MessageTypeCd; string; メッセージ・タイプを示すコード。 使用可能な値は、レスポンス、顧客入力、システム・ノート、システム・レスポンスおよび内部ノートです。 受け入れられる値のリストは、参照ORA_SVC_MESSAGE_TYPE_CDで定義されます。
- NotificationProcessingStatusCd; string; レスポンス通知のステータスを示すコード。 たとえば、エラー、成功です。 受け入れられる値のリストは、参照ORA_SVC_MESSAGE_PROCESS_CDで定義されます。
- NotificationRetryCount; integer;システムがSRメッセージ通知を送信しようとした回数。
- ObjectId; integer;オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。
- ObjectTypeCd; string;このフィールドは内部使用のためにのみ予約されています。
- OriginalSystemReference; string;メッセージがインポートされた元のソース・システムのメッセージ・レコードの識別子。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。
- OriginationDate; string;元のソース・システムでメッセージが作成された日付。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。
- ParentMessageId; integer; 親サービス・リクエスト・メッセージの一意の識別子。
- PartyName; string; メッセージを投稿したユーザーのパーティ名。 ユーザーには、内部リソースまたは顧客担当者を指定できます。
- PostedByPartyId; integer; メッセージを投稿したユーザーの一意の識別子。 ユーザーには、内部リソースまたは顧客担当者を指定できます。
- PostedByPartyNumber; string;サービス・リクエストにメッセージを投稿する個人の公開一意識別子。
- PrivateInformationFlag; boolean;メッセージに個人を特定できる情報が含まれているかどうかを示します。
- ProcessingId; integer; 処理の一意の識別子。
- ProcessingStatusCd; string; メッセージの処理ステータスを示すコード。 受け入れられる値は、Ready、Processing、Error、および受け入れられる値のSuccess.Aリストは、参照ORA_SVC_MESSAGE_PROCESS_CDで定義されます。
- RichTextFlag; boolean。メッセージ・コンテンツがリッチ・テキスト形式かどうかを示します。 書式がリッチ・テキストの場合、値はY、それ以外の場合はNです。
- RootMessageId; integer; メッセージ階層内のルート・メッセージの識別子。
- SentDate; string; メッセージが送信された日時。
- SocialPrivateFlag; boolean;メッセージがプライベート・ソーシャル投稿から作成されたかどうかを示します。
- SourceCd; string; メッセージのソースを示すコード。 たとえば、エージェントUI、顧客UIおよびAPIです。 受け入れられる値のリストは、参照ORA_SVC_SOURCE_CDで定義されます。
- SrBUOrgId; integer; サービス・リクエストに関連付けられたビジネス・ユニットの識別子。
- SrId; integer;メッセージが関連付けられているサービス・リクエストの一意の識別子。
- SrInlineAttachmentIds; string;サービス・リクエストに関連付けられたインライン添付識別子のリスト
- SrNumber; string; サービス・リクエストのパブリックの一意の番号。
- SrStripeCd; string; サービス・リクエストのアプリケーション・ストライプ。
- StatusCd; string; メッセージのステータスを示すコード。 受け入れられる値は、ドラフト、コミット済および訂正済です。
- Subject; string;サービス・リクエスト・メッセージの件名。
- TemplateName; string; 顧客への電子メール・レスポンスの送信に使用されるテンプレートの名前。
- ThreadHierarchyLevel; integer; メッセージ階層内のスレッドのレベル。
- ThreadId; integer; サービス・リクエスト・メッセージ・スレッドの一意のID。
- VisibilityCd; string; メッセージのプライバシ・レベルを示すコード。 受け入れられる値は内部および外部です。 Null値は、メッセージが外部であることを示します。 受け入れられる値のリストは、参照ORA_SVC_MESSAGE_VISIBILITY_CDで定義されます。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : serviceRequests-messages
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : serviceRequests-messages-item-response
タイプ:
ソースを表示
object
-
Attachment: array Attachments
タイトル:
Attachments
添付リソースは、メッセージに関連付けられた添付の表示、作成、更新および削除に使用されます。 添付には、メッセージに関する追加情報が含まれます。 -
channelCommunication: array Channel Communications
タイトル:
Channel Communications
チャネル通信リソースは、チャネル通信の表示、作成、更新および削除に使用されます。 チャネル通信は、サポート・エージェントとその顧客の間の通信に関する情報です。 たとえば、記録される通信情報のタイプには、メッセージ識別子、担当者識別子および担当者識別子が含まれます。 -
ChannelId: string
タイトル:
Channel
チャネルの一意の識別子。 -
ChannelTypeCd: string
タイトル:
Channel Type
最大長:30
チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。 -
CollabResource: string
タイトル:
Collaboration Resource
このフィールドは、内部使用のためにのみ予約されています。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
メッセージを作成したユーザー。 -
CreatedByEmailAddress: string
タイトル:
Created by Email ID
読取り専用:true
最大長:320
サービス・リクエスト・メッセージを作成したユーザーの電子メール・アドレス。 -
CreatedByPartyId: string
タイトル:
Created by Party ID
読取り専用:true
最大長:80
サービス・リクエスト・メッセージを作成したユーザーの一意の識別子。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
メッセージが作成された日時。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用:true
メッセージが削除されたかどうかを示します。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
MessageContent: 文字列(バイト)
タイトル:
Message Content
基本64形式でエンコードされたメッセージの内容。 メッセージに関連付けられている添付は、メッセージの内容ではありません。 -
MessageCreatedBy: string
タイトル:
Created By
最大長:64
元のソース・システムでメッセージを作成したユーザー。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。 -
MessageExpandingState: integer
タイトル:
Message Expand State
メッセージ展開状態を示します。 -
MessageId: integer (int64)
タイトル:
Message ID
サービス・リクエスト・メッセージの一意の識別子。 -
MessageLastUpdateDate: string (date-time)
タイトル:
Last Updated Date
元のソース・システムでのメッセージの最終更新日。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。 -
MessageLastUpdatedBy: string
タイトル:
Last Updated By
最大長:64
元のソース・システムでメッセージを最後に更新したユーザー。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。 -
MessageLastUpdateLogin: string
タイトル:
Last Update Login
最大長:32
元のソース・システムでメッセージを最後に更新したユーザーのログイン。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。 -
MessageNumber: string
タイトル:
Message Number
最大長:30
サービス・リクエスト・メッセージの公開一意識別子。 -
MessageSubTypeCd: string
タイトル:
Message Subtype
最大長:30
サービス・リクエスト・メッセージ・サブタイプ。 -
MessageTypeCd: string
タイトル:
Message Type Code
最大長:30
メッセージ・タイプを示すコード。 使用可能な値は、レスポンス、顧客入力、システム・ノート、システム・レスポンスおよび内部ノートです。 受け入れられる値のリストは、参照ORA_SVC_MESSAGE_TYPE_CDで定義されます。 -
NetworkTypeCd: string
タイトル:
Network
読取り専用:true
最大長:30
ポストのソーシャル・ネットワークを示すコード。 たとえば、Facebook、Twitterです。 受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。 -
NotificationProcessingStatusCd: string
タイトル:
Notification Processing Status Code
最大長:30
レスポンス通知のステータスを示すコード。 たとえば、エラー、成功です。 受け入れられる値のリストは、参照ORA_SVC_MESSAGE_PROCESS_CDで定義されます。 -
NotificationRetryCount: 整数(int32)
タイトル:
Notification Retry Count
システムがSRメッセージ通知を送信しようとした回数。 -
ObjectId: integer (int64)
タイトル:
Object ID
オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。 -
ObjectTypeCd: string
タイトル:
Object Type Code
最大長:30
デフォルト値:SVC_SR_MESSAGES
このフィールドは、内部使用のためにのみ予約されています。 -
OriginalSystemReference: string
タイトル:
Original System
最大長:255
メッセージのインポート元の元のソース・システム内のメッセージ・レコードの識別子。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。 -
OriginationDate: string (date-time)
タイトル:
Origination Date
元のソース・システムでメッセージが作成された日付。 これは、サービス・リクエスト・メッセージが別のシステムからインポートされた場合に適用されます。 -
ParentMessageId: integer (int64)
タイトル:
Parent Message ID
親サービス・リクエスト・メッセージの一意の識別子。 -
PartyName: string
タイトル:
Posted By
読取り専用:true
最大長:360
メッセージをポストしたユーザーのパーティ名。 ユーザーには、内部リソースまたは顧客担当者を指定できます。 -
PostedByPartyId: integer (int64)
タイトル:
Posted by ID
メッセージをポストしたユーザーの一意の識別子。 ユーザーには、内部リソースまたは顧客担当者を指定できます。 -
PostedByPartyNumber: string
タイトル:
Posted by Party Number
読取り専用:true
最大長:30
サービス・リクエストにメッセージを投稿する個人の公開一意識別子。 -
PrivateInformationFlag: boolean
タイトル:
Contains PII Data
最大長:1
メッセージに個人を識別可能な情報が含まれているかどうかを示します。 -
ProcessingId: integer (int64)
タイトル:
Processing ID
読取り専用:true
処理の一意の識別子。 -
ProcessingStatusCd: string
タイトル:
Processing Status
最大長:30
デフォルト値:ORA_SVC_READY
メッセージの処理ステータスを示すコード。 受け入れられる値は、Ready、Processing、Error、および受け入れられる値のSuccess.Aリストは、参照ORA_SVC_MESSAGE_PROCESS_CDで定義されます。 -
ReplyToMessageId: integer (int64)
タイトル:
Reply to Message ID
読取り専用:true
エージェントが応答しているメッセージの一意の識別子。 -
RichTextFlag: boolean
タイトル:
Rich Text
最大長:1
デフォルト値:true
メッセージ・コンテンツがリッチ・テキスト形式かどうかを示します。 書式がリッチ・テキストの場合、値はY、それ以外の場合はNです。 -
RootMessageId: integer (int64)
タイトル:
Root Message Identifier
読取り専用:true
メッセージ階層のルート・メッセージの識別子。 -
RootThreadCount: integer
タイトル:
Root Message Thread Count
読取り専用:true
サービス・リクエストのルート・メッセージに含まれるメッセージの数。 -
RootThreadLastUpdateDate: string (date-time)
タイトル:
Root Message Thread Last Updated Date
読取り専用:true
サービス・リクエストのルート・メッセージのすべてのメッセージの最新の更新日。 -
SentDate: string (date-time)
タイトル:
Sent Date
メッセージが送信された日時。 -
SocialPrivateFlag: boolean
タイトル:
Private Message
最大長:1
メッセージがプライベート・ソーシャル投稿から作成されたかどうかを示します。 -
SourceCd: string
タイトル:
Source Code
最大長:30
メッセージのソースを示すコード。 たとえば、エージェントUI、顧客UIおよびAPIです。 受け入れられる値のリストは、参照ORA_SVC_SOURCE_CDで定義されます。 -
SrBUOrgId: integer (int64)
タイトル:
Service Request Business Unit
読取り専用:true
サービス・リクエストに関連付けられたビジネス・ユニットの識別子。 -
SrId: integer (int64)
タイトル:
Service Request ID
メッセージが関連付けられているサービス・リクエストの一意の識別子。 -
SrInlineAttachmentIds: string
タイトル:
Inline Attachment Identifiers
最大長:1000
サービス・リクエストに関連付けられたインライン添付識別子のリスト -
SrNumber: string
タイトル:
Service Request Number
最大長:30
サービス・リクエストの公開固有番号。 -
SrStripeCd: string
タイトル:
Service Request Application Stripe
読取り専用:true
最大長:30
サービス・リクエストのアプリケーション・ストライプ。 -
StatusCd: string
タイトル:
Status Code
最大長:30
メッセージのステータスを示すコード。 受け入れられる値は、ドラフト、コミット済および訂正済です。 -
Subject: string
タイトル:
Subject
最大長:1000
サービス・リクエスト・メッセージの件名。 -
TemplateName: string
タイトル:
Template Name
最大長:240
顧客へのEメール・レスポンスの送信に使用されるテンプレートの名前。 -
ThreadCount: integer
タイトル:
Thread Count
読取り専用:true
サービス・リクエスト・メッセージのスレッド数。 -
ThreadHierarchyLevel: integer
タイトル:
Thread Hierarchy Level
読取り専用:true
メッセージ階層内のスレッドのレベル。 -
ThreadId: integer
タイトル:
Thread Identifier
読取り専用:true
サービス・リクエスト・メッセージ・スレッドの一意のID。 -
ThreadLastUpdateDate: string (date-time)
タイトル:
Thread Last Updated Date
読取り専用:true
メッセージが最後に更新された日付。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用:true
メッセージが更新されたかどうかを示します。 -
VisibilityCd: string
タイトル:
Visibility Code
最大長:30
メッセージのプライバシ・レベルを示すコード。 受け入れられる値は内部および外部です。 Null値は、メッセージが外部であることを示します。 受け入れられる値のリストは、参照ORA_SVC_MESSAGE_VISIBILITY_CDで定義されます。
ネストされたスキーマ : 添付ファイル
タイプ:
array
タイトル:
Attachments
添付リソースは、メッセージに関連付けられた添付の表示、作成、更新および削除に使用されます。 添付には、メッセージに関する追加情報が含まれます。
ソースを表示
ネストされたスキーマ : チャネル通信
タイプ:
array
タイトル:
Channel Communications
チャネル通信リソースは、チャネル通信の表示、作成、更新および削除に使用されます。 チャネル通信は、サポート・エージェントとその顧客の間の通信に関する情報です。 たとえば、記録される通信情報のタイプには、メッセージ識別子、担当者識別子および担当者識別子が含まれます。
ソースを表示
ネストされたスキーマ : serviceRequests-messages-Attachment-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
AttachmentsDFFVL: array AttachmentsDFFVL
-
AttachmentsPreview: array Attachments Preview
タイトル:
Attachments Preview
添付プレビュー・リソースは、添付ページのプレビューに使用されます。 -
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
添付のURL。 -
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
添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付に関連付けられているログイン。
ネストされたスキーマ : serviceRequests-messages-Attachment-AttachmentsDFFVL-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Segment
最大長:150
-
__FLEX_Context_DisplayValue: string
タイトル:
Context Segment
-
AttachedDocumentId: integer (int64)
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : serviceRequests-messages-Attachment-AttachmentsPreview-item-response
タイプ:
ソースを表示
object
-
ImageHeight: integer
タイトル:
Image Height
読取り専用:true
プレビューされたイメージの高さ。 -
ImageSource: string
タイトル:
Image Source
読取り専用:true
base64でエンコードされたPNG形式のイメージのプレビュー。 -
ImageWidth: integer
タイトル:
Image Width
読取り専用:true
プレビューされたイメージの幅。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PageNum: integer
タイトル:
Page Number
読取り専用:true
プレビュー内のページの番号。
ネストされたスキーマ : serviceRequests-messages-channelCommunication-item-response
タイプ:
ソースを表示
object
-
ChannelAccountName: string
タイトル:
Account Name
読取り専用:true
最大長:400
チャネルに関連付けられたアカウント名。 たとえば、電子メールの場合、アカウント名は、support@abc.comなどのサポート用のインバウンド・メールボックスになります。 -
ChannelDisplayName: string
タイトル:
Display Name
最大長:400
チャネルの表示名。 -
ChannelId: integer (int64)
タイトル:
Channel ID
チャネルの一意の識別子。 -
ChannelShortName: string
タイトル:
Channel Short Name
最大長:450
チャネルのパブリック一意識別子。 -
ChannelTypeCd: string
タイトル:
Channel Type
読取り専用:true
最大長:30
チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。 -
CollabId: string
タイトル:
Collaboration ID
読取り専用:true
最大長:255
対応するネットワークのコラボレーション・ネットワーク・ユーザーの一意の識別子。 この例として、ユーザーのユーザーIDが不足しています。 -
CollabName: string
タイトル:
Resource Name
読取り専用:true
最大長:400
コラボレーション・ネットワーク上の外部ユーザーのユーザー名です。 -
CollabResourceId: integer (int64)
タイトル:
Collaboration Resource Identifier
内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーの一意の識別子。 -
ContactPointId: integer (int64)
タイトル:
Contact Point ID
連絡中の担当者の担当者レコードの一意の識別子。 担当者は、特定の通信チャネルに対する担当者の識別子です。 たとえば、Eメール・チャネルの担当者はEメール・アドレスで、Twitterの個人の担当者はTwitterハンドルです。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
通信チャネルを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
通信チャネルが作成された日時。 -
InboundObjectId: integer (int64)
タイトル:
Inbound Message Object Identifier
サービス・リクエスト・メッセージを作成したインバウンド・オブジェクトの一意の識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
通信チャネルが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Updated By
読取り専用:true
最大長:64
通信チャネルを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Update Login
読取り専用:true
最大長:32
通信チャネルを最後に更新したユーザーに関連付けられたセッション・ログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MessageNumber: string
タイトル:
Message Number
読取り専用:true
最大長:30
サービス・リクエスト・メッセージの公開一意識別子。 -
NetworkTypeCd: string
タイトル:
Network
読取り専用:true
最大長:30
ポストのソーシャル・ネットワークを示すコード。 たとえば、Facebook、Twitterです。 受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。 -
ObjectId: integer (int64)
タイトル:
Object ID
オブジェクトの一意の識別子。 オブジェクト・タイプに応じて、チャネル通信に関連付けられているサービス・リクエストIDまたはサービス・リクエスト・メッセージIDを示します。 -
ObjectTypeCd: string
タイトル:
Object Type
読取り専用:true
最大長:30
デフォルト値:SVC_SR_MESSAGES
チャネル通信レコードがサービス・リクエストに関連付けられているか、サービス・リクエスト・メッセージに関連付けられているかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_OBJECT_TYPE_CDで定義されます。 -
PartyId: integer (int64)
タイトル:
Party ID
連絡中の個人の一意のパーティ識別子。 -
PartyName: string
タイトル:
Party Name
読取り専用:true
最大長:360
連絡中の個人のパーティ名。 ユーザーには、内部リソースまたは顧客担当者を指定できます。 -
PartyNumber: string
タイトル:
Party Number
読取り専用:true
最大長:30
サービス・リクエスト・メッセージに関連付けられている担当者の公開一意識別子。 -
PartyViaEndPoint: string
タイトル:
Party Endpoint
最大長:1000
Party_ID所有者との通信に使用されるエンドポイント。 たとえば、Eメール・アドレスや電話番号などです。 Party_IDがNULLで、PartyViaEndPointがNULLでない場合、エンドポイントはアドホック・パーティに属します。 -
PersonId: integer (int64)
タイトル:
Person ID
サービス・リクエストの担当者である個人の一意の識別子。 -
PostIdentifier: string
タイトル:
Post Identifier
最大長:1000
サービス・リクエストまたはサービス・リクエスト・メッセージの作成に使用されたソーシャル・メディア・ポスト・レコードの一意の識別子。 -
ResourceId: integer (int64)
タイトル:
Resource ID
読取り専用:true
サービス・リクエストに関連付けられたリソースの一意の識別子。 これは、内部ユーザーが通信しているコラボレーション・ネットワーク・ユーザーを識別できる外部キーです。 -
ResourceTypeCd: string
タイトル:
Resource Type
読取り専用:true
最大長:30
USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレイティブ・ネットワーク・ユーザーのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_COLLAB_RES_TYPE_CDで定義されます。 -
RoutingCd: string
タイトル:
Routing Code
最大長:30
エンドポイントを介したメッセージのルーティング方法を示すコード。 たとえば、エンドポイントが電子メール・アドレスである場合、受信者がTO、CCまたはBCC受信者のいずれであるかがフィールドに表示されます。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_ROUTING_CDで定義されます。 -
ViaId: integer (int64)
タイトル:
ID
読取り専用:true
チャネル通信の一意の識別子。
例:
次の例は、RESTリソースに対してGETリクエストを発行してすべてのメッセージを取得する方法を示しています。
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200 OK Date: Wed, 20 Sep 2016 11:07:50 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "MessageId": 300100092156944, "CreationDate": "2016-09-08T03:54:03-07:00", "CreatedBy": "SALES_REPRESENTATIVE", "LastUpdateDate": "2016-09-08T03:54:58-07:00", "LastUpdatedBy": "SALES_REPRESENTATIVE", "LastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "SrId": 300100092156941, "MessageTypeCd": "ORA_SVC_FORWARD", "ChannelTypeCd": "ORA_SVC_EMAIL", "ChannelId": "2", "PostedByPartyId": 100010032635399, "RichTextFlag": true, "SourceCd": null, "StatusCd": "ORA_SVC_COMMITTED", "ProcessingStatusCd": "ORA_SVC_READY", "VisibilityCd": null, "SentDate": null, "OriginationDate": "2016-09-08T03:54:03-07:00", "MessageCreatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateDate": "2016-09-08T03:54:03-07:00", "MessageLastUpdatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "OriginalSystemReference": null, "PartyName": "Dan Foreman", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156944", "name": "messages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156944", "name": "messages", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156944/lov/SourceCdLookup", "name": "SourceCdLookup", "kind": "collection" }, . . . ] }, { "MessageId": 300100092156943, "CreationDate": "2016-09-08T03:53:36-07:00", "CreatedBy": "SALES_REPRESENTATIVE", "LastUpdateDate": "2016-09-08T03:53:54-07:00", "LastUpdatedBy": "SALES_REPRESENTATIVE", "LastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "SrId": 300100092156941, "MessageTypeCd": "ORA_SVC_CUSTOMER_ENTRY", "ChannelTypeCd": null, "ChannelId": null, "PostedByPartyId": 100010032635399, "RichTextFlag": true, "SourceCd": null, "StatusCd": "ORA_SVC_COMMITTED", "ProcessingStatusCd": "ORA_SVC_READY", "VisibilityCd": null, "SentDate": null, "OriginationDate": "2016-09-08T03:53:36-07:00", "MessageCreatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateDate": "2016-09-08T03:53:36-07:00", "MessageLastUpdatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "OriginalSystemReference": null, "PartyName": "Dan Foreman", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156943", "name": "messages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156943", "name": "messages", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, . . . ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages", "name": "messages", "kind": "collection" } ] }