オブジェクト・リンクの取得
get
/crmRestApi/resources/11.13.18.05/objectLinks/{LinkNumber}
リクエスト
パス・パラメータ
- LinkNumber(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : objectLinks-item-response
タイプ:
ソースを表示
object-
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64行を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:true行が作成された日付。 -
DeleteFlag: boolean
読取り専用:
trueユーザーがレコードを削除できるかどうかを示します。 -
InwardCd: string
タイトル:
Inward読取り専用:true最大長:30リンク・タイプの内向方向を記述する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。 -
InwardCdMeaning: string
タイトル:
Inward Value読取り専用:true最大長:255オブジェクト・リンクに使用されるリンク・タイプの内部参照コードの表示値。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:trueオブジェクト・リンク・タイプが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64オブジェクト・リンク・タイプを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32行を最後に更新したユーザーのログイン。 -
LinkId: integer
タイトル:
Link ID読取り専用:trueオブジェクト・リンク識別子。 -
LinkNumber: string
タイトル:
Link Number最大長:64オブジェクト・リンクの参照番号。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
LinkTypeNumber: string
タイトル:
Link Type Number最大長:64ソース・オブジェクトとターゲット・オブジェクト間のリンクのタイプ。 -
LinkTypeShortName: string
タイトル:
Short Name最大長:20リンク・タイプの一意の名前。 外側コードと内側コードは短縮名に基づいて自動生成されます。 -
Name: string
タイトル:
Name読取り専用:true最大長:400リンク・タイプのわかりやすい名前。 -
ObjectReference: string
タイトル:
Object Reference読取り専用:trueSourceObjectReferenceとTargetObjectReferenceの両方を問い合せるために使用できる参照値。 -
ObjectTypeCd: string
タイトル:
Object Type読取り専用:trueオブジェクトのタイプを示す参照コード。 これは、SourceObjectTypeCdとTargetObjectTypeCdの両方を問い合せるために使用できます。 -
OutwardCd: string
タイトル:
Outward読取り専用:true最大長:30リンク・タイプの外部方向を説明する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。 -
OutwardCdMeaning: string
タイトル:
Outward Value読取り専用:true最大長:255オブジェクト・リンクに使用されるリンク・タイプの外注参照コードの表示値。 -
SourceObjectId: integer
タイトル:
Source IDソース・オブジェクトの識別子。 -
SourceObjectReference: string
タイトル:
Source Reference最大長:64ソース・オブジェクトの参照値。 -
SourceObjectTypeCd: string
タイトル:
Source Type最大長:30ソース・オブジェクトのタイプを示す参照コード。 -
SourceObjectTypeCdMeaning: string
タイトル:
Source Type Value読取り専用:true最大長:255ソース・オブジェクト・タイプ参照コードの表示値。 -
TargetObjectId: integer (int64)
タイトル:
Target IDターゲット・オブジェクトの一意の識別子。 -
TargetObjectReference: string
タイトル:
Target Reference最大長:64ターゲット・オブジェクトの参照値。 -
TargetObjectTypeCd: string
タイトル:
Target Type最大長:30ターゲット・オブジェクトのタイプを示す参照コード。 -
TargetObjectTypeCdMeaning: string
タイトル:
Target Type Value読取り専用:true最大長:255ターゲット・オブジェクト・タイプ参照コードの表示値。 -
UpdateFlag: boolean
読取り専用:
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値を変更します。
リンク
- ObjectLinkTypeLOV
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: LinkTypeNumber;ターゲット属性: LinkTypeNumber
- 表示属性: ShortName、名前、LinkTypeNumber
- ObjectTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_LINK_OBJECT_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: TargetObjectTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行して、オブジェクト・リンクを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinks
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"LinkId": 300100547490303,
"LinkNumber": "CDRM_0000014009",
"SourceObjectReference": "SR0000081148",
"SourceObjectTypeCd": "ServiceRequest",
"SourceObjectTypeCdMeaning": "Service Request",
"SourceObjectId": null,
"TargetObjectReference": "SR0000011019",
"TargetObjectTypeCd": "ServiceRequest",
"TargetObjectTypeCdMeaning": "Service Request",
"TargetObjectId": null,
"LinkTypeNumber": "LT_1",
"CreationDate": "2021-08-16T15:06:13+00:00",
"CreatedBy": "AUTOUICASE2",
"LastUpdateDate": "2021-08-16T15:06:13.126+00:00",
"LastUpdatedBy": "AUTOUICASE2",
"LastUpdateLogin": "C9631A5C51BC3578E0531C5CF00AC03E",
"Name": "A Link Type of blocks",
"OutwardCd": "ORA_SVC_BLOCKS",
"InwardCd": "ORA_SVC_BLOCKS_I",
"InwardCdMeaning": "Is Blocked By",
"LinkTypeShortName": "BLOCKS",
"ObjectTypeCd": null,
"ObjectReference": null,
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinks/CDRM_0000014009",
"name": "objectLinks",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinks/CDRM_0000014009",
"name": "objectLinks",
"kind": "item"
}
]
}