参照コードの取得
get
servername/fscmRestApi/resources/11.13.18.05/commonLookups/{LookupType}/child/lookupCodes/{LookupCode}
リクエスト
パス・パラメータ
- LookupCode(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用して収集リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
- LookupType(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/vnd.oracle.adf.resourceitem+json
- application/json
デフォルト・レスポンス
次の表に、このタスクのデフォルト・レスポンスを示します。
Headers
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : commonLookups-lookupCodes-item-response
すべてに一致
Show Source
- object ItemProperties
- object 共通参照コードVO
タイトル:
Common Lookup Codes VO
- object commonLookups-lookupCodes-item-response-allOf[2]
ネストされたスキーマ : ItemProperties
タイプ:
Show Source
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられているリンクの関係。
ネストされたスキーマ : 共通参照コードVO
タイプ:
object
タイトル:
Show Source
Common Lookup Codes VO
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザーです。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
摘要: string
タイトル:
Description
最大長:240
参照コードの摘要。 -
DisplaySequence: 整数(int64)
タイトル:
Display Sequence
参照コードを表示する順序。 -
EnabledFlag: string
タイトル:
Enabled
最大長:1
デフォルト値:Y
参照コードが有効かどうかを示します。 -
EndDateActive: 文字列(日付)
タイトル:
End Date
参照コードがアクティブでなくなる日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードの最終更新日。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン資格証明。 -
LookupCode: string
タイトル:
Lookup Code
最大長:30
参照を識別する一意のコード。 -
意味: string
タイトル:
Meaning
最大長:80
参照コードの内容。 -
StartDateActive: 文字列(日付)
タイトル:
Start Date
参照コードがアクティブになる日付。 -
タグ: string
タイトル:
Tag
最大長:150
参照コードのフィルタに使用されるオプションのタグ。
ネストされたスキーマ : リンク
タイプ:
Show Source
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.
ネストされたスキーマ : commonLookups-lookupCodes-lookupsDFF-item-response
すべてに一致
Show Source
- object ItemProperties
- object 弁別子: __FLEX_Context
弁別子 :
{ "propertyName":"__FLEX_Context" }
ネストされたスキーマ : 弁別子 : __FLEX_Context
タイプ:
Show Source
object
-
__FLEX_Context: string
タイトル:
Context Segment
最大長:30
-
__FLEX_Context_DisplayValue: string
タイトル:
Context Segment
-
loc: string
タイトル:
loc
最大長:150
-
LookupCode: string
タイトル:
Lookup Code
最大長:30
-
LookupType: string
タイトル:
Lookup Type
最大長:30
-
sd1: string
タイトル:
sd1
最大長:150
-
SetId: 整数(int64)
タイトル:
Reference Data Set
-
ViewApplicationId: 整数(int64)
ネストされたスキーマ : commonLookups-lookupCodes-translations-item-response
すべてに一致
Show Source
- object ItemProperties
- object 共通参照コード翻訳VO
タイトル:
Common Lookup Codes Translations VO
ネストされたスキーマ : 共通参照コード翻訳VO
タイプ:
object
タイトル:
Show Source
Common Lookup Codes Translations VO
-
CreatedBy: string
読取り専用:
true
最大長:64
-
CreationDate: string (date-time)
読取り専用:
true
-
摘要: string
最大長:
240
-
言語: string
最大長:
30
-
LastUpdateDate: string (date-time)
読取り専用:
true
-
LastUpdatedBy: string
読取り専用:
true
最大長:64
-
LastUpdateLogin: string
読取り専用:
true
最大長:32
-
意味: string
最大長:
80
-
SourceLang: string
最大長:
4