インバウンド・メッセージ・パートの取得
get
/crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}
リクエスト
パス・パラメータ
- InboundMessageId(required): integer(int64)
インバウンド・メッセージの一意の識別子。
- InboundMsgPartId(required): integer(int64)
メッセージ・パートの一意の識別子。
問合せパラメータ
- 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : inboundMessages-InboundMsgParts-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
インバウンド・メッセージ・パートを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
インバウンド・メッセージ・パートが作成された日付。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用:true
インバウンド・メッセージ・パートを削除できるかどうかを示します。 -
InboundMessageId: integer (int64)
タイトル:
Inbound Message ID
メッセージ・パートが関連付けられているインバウンド・メッセージの一意の識別子。 -
InboundMsgPartId: integer (int64)
タイトル:
Inbound Message Part ID
メッセージ・パートの一意の識別子。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PartName: string
タイトル:
Part Name
最大長:64
インバウンド・メッセージ部分のヘッダー名。 -
PartTypeCd: string
タイトル:
Part Type Code
最大長:30
インバウンド・メッセージ部分のタイプ。 -
PartTypeCdMeaning: string
タイトル:
Part Type Value
最大長:255
インバウンド・メッセージの部品タイプ参照コードに対応する表示値。 -
PartValue: string
タイトル:
Part Value
最大長:2000
インバウンド・メッセージ部分の値。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用:true
インバウンド・メッセージ・パートを更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- PartTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_PART_TYPE
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: PartTypeCd;ターゲット属性: LookupCode
- 表示属性: LookupCode
- ファインダ:
例:
次の例は、RESTリソースに対してGETリクエストを発行してインバウンド・メッセージ部分を取得する方法を示しています。
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
GET /crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200 OK Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次の例は、レスポンス本文の内容を示しています。
"InboundMsgPartId": 300100091977703, "InboundMessageId": 300100091977695, "PartTypeCd": "ORA_SVC_TO", "PartName": "To", "PartValue": "incoming@server.fa.us2.oraclecloud.com", "CreationDate": "2017-04-02T19:54:21.004+00:00", "CreatedBy": "FUSION_APPS_CRM_ESS_APPID", "LastUpdateDate": "2017-04-02T19:54:21.014+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703", "name": "InboundMsgParts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703", "name": "InboundMsgParts", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695", "name": "inboundMessages", "kind": "item" } ] }