すべての標準参照の取得
get
http://servername/fscmRestApi/resources/11.13.18.05/standardLookups
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- LookupTypeFinder :参照タイプのすべての参照を検索します。
ファインダ変数:- LookupType :参照タイプの一意の識別子。
- PrimaryKey :指定された主キーの標準参照を検索します。
ファインダ変数:- LookupType :参照タイプの一意の識別子。
- LookupTypeFinder :参照タイプのすべての参照を検索します。
- 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=Deptno>=10 and <= 30;Loc!=NY
フォーマット: ?q=expression1;expression2 - totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には推定行数が含まれます。それ以外の場合、行数は含まれません。 デフォルト値は"false"です。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
- application/vnd.oracle.adf.resourcecollection+json
デフォルト・レスポンス
次の表に、このタスクのデフォルト・レスポンスを示します。
Headers
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
ネストされたスキーマ : CollectionProperties
タイプ:
Show Source
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
レスポンスで返されたサブセットより多くのリソースをサーバーで使用できるかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられているリンクの関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : standardLookups-allOf[1]
タイプ:
Show Source
object
-
items: array Items
タイトル:
Items
コレクション内のアイテム。
ネストされたスキーマ : リンク
タイプ:
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.
ネストされたスキーマ : standardLookups-item-response
すべてに一致
Show Source
- object ItemProperties
- object 標準参照タイプVO
タイトル:
Standard Lookup Types VO
- object standardLookups-item-response-allOf[2]
ネストされたスキーマ : ItemProperties
タイプ:
Show Source
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられているリンクの関係。
ネストされたスキーマ : 標準参照タイプVO
タイプ:
object
タイトル:
Show Source
Standard Lookup Types VO
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザーです。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
CustomizationLevel: string
タイトル:
Lookup Configuration Level
最大長:1
デフォルト値:U
CustomizationLevelを示すコード。 -
摘要: string
タイトル:
Description
最大長:240
参照の摘要。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードの最終更新日。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン資格証明。 -
LookupType: string
タイトル:
Lookup Type
最大長:30
参照を識別する参照タイプです。 -
意味: string
タイトル:
Meaning
最大長:80
参照の内容。 -
ModuleId: string
タイトル:
Module
最大長:32
モジュールの一意の識別子。 -
RestAccessSecured: string
タイトル:
REST Access Secured
最大長:8
関連付けられたRESTサービスのセキュリティ・セットのレベル。
ネストされたスキーマ : standardLookups-lookupCodes-item-response
すべてに一致
Show Source
- object ItemProperties
- object 標準参照コードVO
タイトル:
Standard Lookup Codes VO
- object standardLookups-lookupCodes-item-response-allOf[2]
ネストされたスキーマ : 標準参照コードVO
タイプ:
object
タイトル:
Show Source
Standard 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
参照コードのフィルタに使用されるオプションのタグ。
ネストされたスキーマ : standardLookups-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)
ネストされたスキーマ : standardLookups-lookupCodes-translations-item-response
すべてに一致
Show Source
- object ItemProperties
- object 標準参照コード翻訳VO
タイトル:
Standard Lookup Codes Translations VO
ネストされたスキーマ : 標準参照コード翻訳VO
タイプ:
object
タイトル:
Show Source
Standard 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
ネストされたスキーマ : standardLookups-translations-item-response
すべてに一致
Show Source
- object ItemProperties
- object 標準参照タイプ翻訳VO
タイトル:
Standard Lookup Types Translations VO
ネストされたスキーマ : 標準参照タイプ翻訳VO
タイプ:
object
タイトル:
Show Source
Standard Lookup Types Translations VO
-
CreatedBy: string
読取り専用:
true
最大長:64
-
CreationDate: string (date-time)
読取り専用:
true
-
摘要: string
最大長:
240
-
言語: string
最大長:
4
-
LastUpdateDate: string (date-time)
読取り専用:
true
-
LastUpdatedBy: string
読取り専用:
true
最大長:64
-
LastUpdateLogin: string
読取り専用:
true
最大長:32
-
意味: string
タイトル:
Meaning
最大長:80
-
SourceLang: string
最大長:
4