ソース・システム参照の取得
get
/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/{SourceSystemReferenceId}
リクエスト
パス・パラメータ
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : hubSourceSystemReferences-item-response
タイプ:
ソースを表示
object
-
Attribute1: string
最大長:
150
文字列1にマップされたフレックスフィールドの列に値を格納します。 -
Attribute10: string
最大長:
150
文字列10にマップされたフレックスフィールドの列に値を格納します。 -
Attribute11: string
最大長:
150
文字列11にマップされたフレックスフィールドの列に値を格納します。 -
Attribute12: string
最大長:
150
文字列12にマップされたフレックスフィールドの列に値を格納します。 -
Attribute13: string
最大長:
150
文字列13にマップされたフレックスフィールドの列に値を格納します。 -
Attribute14: string
最大長:
150
文字列14にマップされたフレックスフィールドの列に値を格納します。 -
Attribute15: string
最大長:
150
文字列15にマップされたフレックスフィールドの列に値を格納します。 -
Attribute16: string
最大長:
150
文字列16にマップされたフレックスフィールドの列に値を格納します。 -
Attribute17: string
最大長:
150
文字列17にマップされたフレックスフィールドの列に値を格納します。 -
Attribute18: string
最大長:
150
文字列18にマップされたフレックスフィールドの列に値を格納します。 -
Attribute19: string
最大長:
150
文字列19にマップされたフレックスフィールドの列に値を格納します。 -
Attribute2: string
最大長:
150
文字列2にマップされたフレックスフィールドの列に値を格納します。 -
Attribute20: string
最大長:
150
文字列20にマップされたフレックスフィールドの列に値を格納します。 -
Attribute21: string
最大長:
150
文字列21にマップされたフレックスフィールドの列に値を格納します。 -
Attribute22: string
最大長:
150
文字列22にマップされたフレックスフィールドの列に値を格納します。 -
Attribute23: string
最大長:
150
文字列23にマップされたフレックスフィールドの列に値を格納します。 -
Attribute24: string
最大長:
150
文字列24にマップされたフレックスフィールドの列に値を格納します。 -
Attribute25: string
最大長:
150
文字列25にマップされたフレックスフィールドの列に値を格納します。 -
Attribute26: string
最大長:
150
文字列26にマップされたフレックスフィールドの列に値を格納します。 -
Attribute27: string
最大長:
150
文字列27にマップされたフレックスフィールドの列に値を格納します。 -
Attribute28: string
最大長:
150
文字列28にマップされたフレックスフィールドの列に値を格納します。 -
Attribute29: string
最大長:
150
文字列29にマップされたフレックスフィールドの列に値を格納します。 -
Attribute3: string
最大長:
150
文字列3にマップされたフレックスフィールドの列に値を格納します。 -
Attribute30: string
最大長:
255
文字列30にマップされたフレックスフィールドの列に値を格納します。 -
Attribute4: string
最大長:
150
文字列4にマップされたフレックスフィールドの列に値を格納します。 -
Attribute5: string
最大長:
150
文字列5にマップされたフレックスフィールドの列に値を格納します。 -
Attribute6: string
最大長:
150
文字列6にマップされたフレックスフィールドの列に値を格納します。 -
Attribute7: string
最大長:
150
文字列7にマップされたフレックスフィールドの列に値を格納します。 -
Attribute8: string
最大長:
150
文字列8にマップされたフレックスフィールドの列に値を格納します。 -
Attribute9: string
最大長:
150
文字列9にマップされたフレックスフィールドの列に値を格納します。 -
AttributeCategory: string
最大長:
30
属性には、フレックスフィールドのグループのカテゴリ値が格納されます。 -
AttributeDate1: 文字列(日付)
日付列1にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate10: 文字列(日付)
日付列10にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate11: 文字列(日付)
日付列11にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate12: 文字列(日付)
日付列12にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate2: 文字列(日付)
日付列2にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate3: 文字列(日付)
日付列3にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate4: 文字列(日付)
日付列4にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate5: 文字列(日付)
日付列5にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate6: 文字列(日付)
日付列6にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate7: 文字列(日付)
日付列7にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate8: 文字列(日付)
日付列8にマップされたフレックスフィールドの列に値を格納します。
-
AttributeDate9: 文字列(日付)
日付列9にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber1: number
数値列1にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber10: number
数値列10にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber11: number
数値列11にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber12: number
数値列12にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber2: number
数値列2にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber3: number
数値列3にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber4: number
数値列4にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber5: number
数値列5にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber6: number
数値列6にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber7: number
数値列7にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber8: number
数値列8にマップされたフレックスフィールドの列に値を格納します。
-
AttributeNumber9: number
数値列9にマップされたフレックスフィールドの列に値を格納します。
-
CreatedBy: string
読取り専用:
true
最大長:64
行を作成したユーザー。 -
CreatedByModule: string
最大長:
30
デフォルト値:ORA_ZCH_WS
ソース・システム参照を作成したモジュール。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
行が作成された日時。 -
EndDateActive: 文字列(日付)
ソース・システム参照の終了日。 これは過去の日付にできません。
-
ExistingSourceSystem: string
OSRベース表にすでに存在する参照ソース・システム。 挿入の場合に提供できます。
-
ExistingSourceSystemReferenceValue: string
OSRベース表にすでに存在する参照ソース・システム参照。 挿入の場合に提供できます。 既存のソース・システムおよび既存のソース・システム参照は、新しいソース・システム参照が作成されるFusion識別子を識別するために使用されます。
-
LastUpdateDate: string (date-time)
読取り専用:
true
行が最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
行を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
行を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OwnerEntityId: integer (int64)
新規ソース・システム、ソース・システム参照が関連付けられている所有者エンティティ・オブジェクトのレコードのFusion識別子。 挿入の場合に提供できます。
-
OwnerEntityObject: string
最大長:
30
新しいソース・システム、ソース・システム参照が関連付けられているFusion識別子を保持するTCAエンティティ。 有効な値は、参照タイプORA_ZCH_OWNER_ENTITY_OBJECTの参照コードです。 -
ReasonCode: string
最大長:
30
これは、MOSR_REASON参照タイプに対して検証されます。 -
SourceSystem: string
タイトル:
Source System
最大長:30
ソース・システム名。 挿入の場合に指定します。 -
SourceSystemReferenceId: integer (int64)
読取り専用:
true
順次生成された主キー。 -
SourceSystemReferenceValue: string
最大長:
255
ソース・システム論理エンティティのソース・システムID。 挿入の場合に指定します。 -
StartDateActive: 文字列(日付)
ソース・システム参照の開始日。 将来の日付にできません。
-
Status: string
読取り専用:
true
最大長:1
デフォルト値:A
ソース・システム参照のステータス。 有効な値はアクティブです - 'A'および非アクティブ - 'I'.
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- LookupPVO
-
パラメータ:
- ファインダ:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ZCH_OWNER_ENTITY_OBJECT
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: OwnerEntityObject;ターゲット属性: LookupCode
- 表示属性: LookupCode
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、ソース・システム参照を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください
curl -user sales_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています:
{ "SourceSystemReferenceId": 10766, "SourceSystem": "Pinnacle_Data", "SourceSystemReferenceValue": "145", "OwnerEntityObject": "ALL_SITES", "OwnerEntityId": 1394, "ExistingSourceSystem": null, "ExistingSourceSystemReferenceValue": null, "StartDateActive": "2004-02-23", "EndDateActive": "4712-12-31", "Status": "A", "ReasonCode": null, "CreatedBy": "2045", "CreationDate": "1999-10-06T03:54:14+00:00", "LastUpdatedBy": "2045", "LastUpdateDate": "1999-10-06T03:54:14+00:00", "LastUpdateLogin": "357171", "CreatedByModule": "TCA", "AttributeCategory": null, "Attribute1": null, ... "AttributeDate1": null, "AttributeDate2": null, "AttributeDate3": null, "AttributeDate4": null, "AttributeDate5": null, "AttributeDate6": null, "AttributeDate7": null, "AttributeDate8": null, "AttributeDate9": null, "AttributeDate10": null, "AttributeDate11": null, "AttributeDate12": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766", "name": "hubSourceSystemReferences", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A61766176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766", "name": "hubSourceSystemReferences", "kind": "item" } ] }, ... }